release: v1.7.0 #63
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,66 @@ | ||||||
| # Getting Started | ||||||
|
|
||||||
| ## Install | ||||||
|
|
||||||
| ### Quick install (Linux/macOS) | ||||||
| ```bash | ||||||
| curl -fsSL https://raw.githubusercontent.com/kienbui1995/mc-code/main/install.sh | sh | ||||||
| ``` | ||||||
|
|
||||||
| ### Build from source | ||||||
| ```bash | ||||||
| git clone https://github.com/kienbui1995/mc-code.git | ||||||
| cd mc-code/mc | ||||||
| cargo install --path crates/mc-cli | ||||||
| ``` | ||||||
|
|
||||||
| ## Setup | ||||||
|
|
||||||
| Set your API key: | ||||||
| ```bash | ||||||
| export ANTHROPIC_API_KEY="your-key" | ||||||
| # or: OPENAI_API_KEY, GEMINI_API_KEY, GROQ_API_KEY, etc. | ||||||
| ``` | ||||||
|
|
||||||
| ## First run | ||||||
|
|
||||||
| ```bash | ||||||
| magic-code # interactive TUI | ||||||
| magic-code "fix the bug in auth.rs" # single-shot mode | ||||||
| echo "explain this" | magic-code --pipe # pipe mode | ||||||
| ``` | ||||||
|
|
||||||
| ## Key concepts | ||||||
|
|
||||||
| - **Tools**: Agent has 30 built-in tools (bash, file ops, search, browser, debug, etc.) | ||||||
| - **Memory**: Persistent project facts across sessions (`/memory`) | ||||||
| - **Skills**: Reusable coding patterns (`.magic-code/skills/*.md`) | ||||||
| - **Agents**: Named agent configs (`agents/*.md`) | ||||||
| - **Sessions**: Save/load/branch conversations | ||||||
|
|
||||||
| ## Essential commands | ||||||
|
|
||||||
| | Command | Description | | ||||||
| |---------|-------------| | ||||||
| | `/help` | Show all commands (categorized) | | ||||||
| | `/model` | Switch LLM model | | ||||||
| | `/plan` | Toggle plan mode (think before acting) | | ||||||
| | `/save` | Save current session | | ||||||
| | `/undo` | Undo last file changes | | ||||||
| | `/cost` | Show session cost | | ||||||
| | `/compact` | Compress context when running low | | ||||||
| | `/debug` | Enter structured debugging mode | | ||||||
| | `/gh` | GitHub integration | | ||||||
|
|
||||||
| ## Configuration | ||||||
|
|
||||||
| Create `.magic-code/config.toml` in your project: | ||||||
| ```toml | ||||||
| [default] | ||||||
| model = "claude-sonnet-4-20250514" | ||||||
| max_tokens = 8192 | ||||||
| provider = "anthropic" | ||||||
| notifications = true | ||||||
| ``` | ||||||
|
|
||||||
| See [Configuration Reference](reference/config.md) for all options. | ||||||
|
There was a problem hiding this comment. Fix the relative link path to the config reference. Line 66 currently links to Proposed fix-See [Configuration Reference](reference/config.md) for all options.
+See [Configuration Reference](../reference/config.md) for all options.📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # Memory System | ||
|
|
||
| magic-code has a 3-layer memory system inspired by Claude Code's architecture. | ||
|
|
||
| ## Layer 1: Semantic Memory (Project Facts) | ||
|
|
||
| Persistent key-value facts organized in 4 categories: | ||
|
|
||
| | Category | What it stores | Example | | ||
| |----------|---------------|---------| | ||
| | **project** | Architecture, tools, conventions | `test_cmd = "cargo test"` | | ||
| | **user** | Preferences, role, style | `coding_style = "prefer functional"` | | ||
| | **feedback** | Corrections from user | `"always use snake_case"` | | ||
| | **reference** | File locations, endpoints | `api_endpoint = "localhost:8080"` | | ||
|
|
||
| ### Usage | ||
| ``` | ||
| /memory # list all facts | ||
| /memory get test_cmd # get specific fact | ||
| /memory set test_cmd "pytest" # save fact | ||
| /memory delete old_key # remove fact | ||
| ``` | ||
|
|
||
|
Comment on lines
+17
to
+23
There was a problem hiding this comment. Add language identifiers to plain fenced code blocks. Several fenced blocks (Lines 17, 51, 59, 72, 84) omit language tags, which will keep triggering lint warnings. Suggested update pattern-```
+```text
/memory # list all facts
...Verify each finding against the current code and only fix it if needed. In |
||
| Agent can also use `memory_write` tool with category: | ||
| ```json | ||
| {"key": "db", "value": "PostgreSQL 15", "category": "project"} | ||
| ``` | ||
|
|
||
| ### Auto-memory | ||
| Agent automatically saves facts detected in its output: | ||
| - "project uses..." → project category | ||
| - "convention is..." → feedback category | ||
| - "running on port..." → reference category | ||
| - "user prefers..." → user category | ||
|
|
||
| ### Self-skeptical | ||
| Memory is injected into the system prompt with a warning: | ||
| > *Treat as hints — verify against actual code before acting.* | ||
|
|
||
| This prevents hallucination from stale memory. | ||
|
|
||
| ### Dream cleanup | ||
| When memory exceeds 150 facts, auto-compact runs on session start: | ||
| - Deduplicates by key (keeps newest) | ||
| - Removes stale entries | ||
|
|
||
| ## Layer 2: Episodic Memory (Session History) | ||
|
|
||
| Past conversations saved as JSON files. | ||
|
|
||
| ``` | ||
| ~/.local/share/magic-code/sessions/ | ||
| ├── last.json # auto-saved | ||
| ├── my-feature.json # /save my-feature | ||
| └── debug-auth.json # /save debug-auth | ||
| ``` | ||
|
|
||
| ### Commands | ||
| ``` | ||
| /save <name> # save session | ||
| /load <name> # resume session | ||
| /sessions # list saved sessions | ||
| /search-all <query> # FTS across all sessions | ||
| /fork # branch current session | ||
| /branches # list branches | ||
| ``` | ||
|
|
||
| ## Layer 3: Procedural Memory (Skills) | ||
|
|
||
| Reusable coding patterns stored as markdown files. | ||
|
|
||
| ``` | ||
| .magic-code/skills/ | ||
| ├── setup-nextjs.md # user-created | ||
| ├── deploy-aws.md # user-created | ||
| └── auto/ | ||
| └── auto-3t-8-1713000000.md # auto-generated | ||
| ``` | ||
|
|
||
| ### Auto-skill creation | ||
| After complex successful turns (≥6 tool calls, no errors), agent auto-generates a skill file. Next time it encounters a similar task, it loads the skill. | ||
|
|
||
| ### Named agents | ||
| ``` | ||
| agents/ | ||
| ├── reviewer.md # code review specialist | ||
| └── architect.md # system design specialist | ||
| ``` | ||
|
|
||
| Each agent has its own model, tools, and instructions defined in YAML frontmatter. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Configuration Reference | ||
|
|
||
| ## Config file locations (priority order) | ||
| 1. `.magic-code/config.toml` (project — highest) | ||
| 2. `~/.config/magic-code/config.toml` (user) | ||
| 3. Built-in defaults (lowest) | ||
|
|
||
| ## All options | ||
|
|
||
| ```toml | ||
| [default] | ||
| # LLM | ||
| model = "claude-sonnet-4-20250514" | ||
| max_tokens = 8192 | ||
| provider = "anthropic" | ||
| base_url = "" # custom API endpoint | ||
| fallback_provider = "" # secondary provider | ||
| fallback_model = "" # secondary model | ||
|
|
||
| # Permissions | ||
| permission_mode = "auto" # auto | allow | deny | prompt | ||
|
|
||
| # Context | ||
| compaction_threshold = 0.8 # compact at 80% context usage | ||
| compaction_preserve_recent = 4 # keep last 4 messages | ||
|
|
||
| # Notifications | ||
| notifications = true # bell + desktop notifications | ||
| notification_webhook = "" # Slack/Discord webhook URL | ||
|
|
||
|
Comment on lines
+11
to
+30
There was a problem hiding this comment.
Lines 16–30 include fields that are not loaded from Proposed docs correction [default]
# LLM
model = "claude-sonnet-4-20250514"
max_tokens = 8192
provider = "anthropic"
-base_url = "" # custom API endpoint
-fallback_provider = "" # secondary provider
-fallback_model = "" # secondary model
# Permissions
permission_mode = "auto" # auto | allow | deny | prompt
-
-# Context
-compaction_threshold = 0.8 # compact at 80% context usage
-compaction_preserve_recent = 4 # keep last 4 messages
-
-# Notifications
-notifications = true # bell + desktop notifications
-notification_webhook = "" # Slack/Discord webhook URL
+
+[compaction]
+auto_compact_threshold = 0.8
+preserve_recent_messages = 4Also add a short note that fallback provider/model and notifications are runtime defaults unless explicitly supported by current config schema. 🤖 Prompt for AI Agents |
||
| # Managed Agents | ||
| [managed_agents] | ||
| enabled = false | ||
| executor_model = "claude-haiku-3-5-20241022" | ||
| executor_max_turns = 5 | ||
| max_concurrent = 3 | ||
| budget_usd = 1.0 | ||
| ``` | ||
|
|
||
| ## Environment variables | ||
|
|
||
| | Variable | Description | | ||
| |----------|-------------| | ||
| | `ANTHROPIC_API_KEY` | Anthropic API key | | ||
| | `OPENAI_API_KEY` | OpenAI API key | | ||
| | `GEMINI_API_KEY` | Google Gemini API key | | ||
| | `GROQ_API_KEY` | Groq API key | | ||
| | `DEEPSEEK_API_KEY` | DeepSeek API key | | ||
| | `OPENROUTER_API_KEY` | OpenRouter API key | | ||
| | `XAI_API_KEY` | xAI (Grok) API key | | ||
|
|
||
| ## CLI flags | ||
|
|
||
| ``` | ||
| --model <MODEL> LLM model | ||
| --provider <PROVIDER> Provider name | ||
| --max-tokens <N> Max tokens per response | ||
| --resume Resume last session | ||
| --session-id <ID> Resume specific session | ||
| --pipe Read from stdin | ||
| --json JSON output mode | ||
| --yes Auto-approve (CI/CD) | ||
| --trace Debug logging | ||
| --validate-config Validate and exit | ||
| --max-budget-usd <N> Cost limit | ||
| --max-turns <N> Turn limit | ||
| --add-dir <DIR> Grant access to extra directories | ||
| ``` | ||
|
Comment on lines
+54
to
+68
There was a problem hiding this comment. Add a language identifier to the fenced CLI block. Line 54 starts a fenced code block without language, which triggers markdown lint warnings. Proposed fix-```
+```text
--model <MODEL> LLM model
--provider <PROVIDER> Provider name
...
--add-dir <DIR> Grant access to extra directories🧰 Tools🪛 markdownlint-cli2 (0.22.0)[warning] 54-54: Fenced code blocks should have a language specified (MD040, fenced-code-language) 🤖 Prompt for AI Agents |
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The changelog states that
/search-allsearches across "all saved sessions," but the implementation inmc-core/src/fts.rs(line 41) limits the search to the 100 most recent sessions and stops after finding 20 results (line 93). This discrepancy should be clarified in the documentation or the implementation should be updated to match the description.