Skip to content

Commit 06f1c41

Browse files
authored
Update README.md
1 parent 1c02de7 commit 06f1c41

File tree

1 file changed

+26
-12
lines changed

1 file changed

+26
-12
lines changed

README.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@
55
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
77

8-
## A SQL-like language for efficient code analysis and transformations
9-
108
## Table of Contents
119
- [What is CEDARScript?](#what-is-cedarscript)
12-
- [CEDARScript ELI5'ed](#cedarscript-eli5-ed)
10+
- [CEDARScript ELI5'ed](#cedarscript-eli5ed)
1311
- [Technical Overview](#technical-overview)
1412
- [Key Features](#key-features)
1513
- [Supported Languages](#supported-languages)
@@ -19,7 +17,16 @@
1917
- [Future Enhancements](#future-enhancements)
2018
- [Related](#related)
2119

20+
## What is CEDARScript?
21+
22+
A SQL-like language for efficient code analysis and transformations.
23+
24+
Most useful for AI code assistants.
25+
2226
## CEDARScript ELI5'ed
27+
<details>
28+
<summary>The Magical Librarian analogy</summary>
29+
2330
Imagine a vast _library_ (`your codebase`) with millions of _books_ (`files`) across thousands of _shelves_ (`directories`).
2431
Traditional code editing is like manually searching through each book, line by line, character by character, to find
2532
relevant information or make changes.
@@ -45,17 +52,15 @@ faster and more intuitive. It bridges the gap between the LLM's _**high-level in
4552
of code structure, allowing the **_architect_** to focus on the '_what_' while it handles the '_how_' of code analysis
4653
and modification.
4754

48-
This **division of labor** between the architect and CEDARScript is not just _efficient_ - it's _economical_.
49-
The **Architect** (_LLM_) conserves valuable resources (_tokens_) by focusing on strategic decisions rather than
50-
character- or line-level editing tasks.
51-
52-
### Audio overview / Podcasts
55+
Audio overview / Podcasts
5356
There are a few podcasts discussing CEDARScript you can listen to:
5457
1. [Aider and the CEDARScript Advantage](https://open.spotify.com/episode/44ojEcwqFDujny82kibKK9?si=DTx_vMfxTpaAtjZULdVFMA) (~18 minutes)
5558
1. [AI coding assistants and the Magical Librarian](https://open.spotify.com/show/4JAc8gphNlUspLV0XxjhQB)
5659
2. [CEDARScript's _TurboKognition_ and _GanzPunktGenau_ editing](https://open.spotify.com/episode/79xCOfrvMZJPenLdKJiNZj?si=Mo2ofU_lRYKwxRZoCPJn6Q)
5760
3. [Discussion of an LLM chat held during a benchmark and some command examples](https://podcasters.spotify.com/pod/show/elifarley/episodes/CEDARScript-chat-during-a-benchmark-test--command-examples-e2ptlq4)
5861

62+
</details>
63+
5964
## Technical Overview
6065
`CEDARScript` (_Concise Examination, Development, And Refactoring Script_) is a **SQL**-like language designed to
6166
lower costs and improve the efficiency and accuracy of AI code assistants. It enables offloading low-level code syntax and
@@ -70,6 +75,10 @@ The **Architect** doesn't need to specify every tiny detail - instead of spendin
7075
complete code changes, it simply provides high-level blueprints using **CEDARScript** commands like
7176
`UPDATE FILE "main.py" MOVE FUNCTION "execute" INSERT AFTER FUNCTION "plan"`.
7277

78+
This **division of labor** between the architect and CEDARScript is not just _efficient_ - it's _economical_.
79+
The **Architect** (_LLM_) conserves valuable resources (_tokens_) by focusing on strategic decisions rather than
80+
character- or line-level editing tasks.
81+
7382
The CEDARScript runtime then handles all the minute details - precise line numbers, indentation counts, and syntax
7483
consistency - at zero token cost.
7584

@@ -219,7 +228,7 @@ There are [many more examples](test/corpus) to look at...
219228
This capability is designed to help developers, AI assistants, and other tools quickly gain a comprehensive understanding of a project's structure, conventions, and context.
220229

221230
### Key Onboarding Features
222-
231+
<details>
223232
1. **Convention Discovery**:
224233
CEDARScript can automatically extract coding conventions from designated files like `CONVENTIONS.md`:
225234

@@ -243,16 +252,19 @@ This capability is designed to help developers, AI assistants, and other tools q
243252
SELECT *
244253
FROM ONBOARDING;
245254
```
255+
</details>
246256

247-
### Future Enhancements
257+
# Future Work
258+
259+
## Future Enhancements
248260

249-
Ideas to explore:
261+
<details>
262+
<summary>Ideas to explore:</summary>
250263

251264
- Automatic generation of project structure visualizations
252265
- Integration with version control history for context-aware onboarding
253266
- Customizable onboarding queries for specific project needs
254267

255-
# Future Work
256268

257269
1. [Tree-Sitter query language](https://cycode.com/blog/tips-for-using-tree-sitter-queries/) integration, which could open up many possibilities;
258270
2. [Comby](https://github.com/comby-tools/comby) notation for an alternate syntax to express refactorings on code or data formats;
@@ -404,6 +416,8 @@ This approach could potentially enhance LLMs' ability to leverage external tools
404416

405417
</details>
406418

419+
</details>
420+
407421
# Related
408422

409423
1. [.QL](https://en.wikipedia.org/wiki/.QL) - Object-oriented query language that enables querying Java source code using SQL-like syntax;

0 commit comments

Comments
 (0)