Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 36 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Magic Shell is an open-source CLI tool that translates plain English (or any nat
## Features

- **Natural Language Translation**: Describe what you want to do in plain English
- **Multiple AI Providers**: OpenCode Zen (with free models!), OpenRouter, and custom models (LM Studio, Ollama, OpenAI-compatible)
- **Multiple AI Providers**: OpenCode Zen (with free models!), OpenRouter, Vercel AI Gateway, Cloudflare AI Gateway, Workers AI, and custom models (LM Studio, Ollama, OpenAI-compatible)
- **Custom Model Support**: Add your own local or remote models with secure API key storage
- **Project Context Aware**: Opt-in detection of package.json scripts, Makefile targets, etc.
- **Interactive TUI Mode**: Full-featured terminal interface with themes
Expand Down Expand Up @@ -104,7 +104,7 @@ mshell
| `msh --add-model` | Add custom model (LM Studio, Ollama, etc.) |
| `msh --list-custom` | List custom models |
| `msh --remove-model <id>` | Remove custom model |
| `msh --provider <name>` | Set provider (opencode-zen or openrouter) |
| `msh --provider <name>` | Set provider (OpenCode Zen, OpenRouter, gateways, Workers AI, or custom) |
| `msh --thinking <level>` | Set thinking level (off, low, medium, high) |
| `msh --themes` | List available themes |
| `msh --theme <name>` | Set color theme |
Expand Down Expand Up @@ -185,23 +185,23 @@ OpenCode Zen provides curated models optimized for coding tasks, including **fre

**Free Models:**

- `minimax-m2.5-free` - MiniMax's free model (default)
- `ling-2.6-flash-free` - Ling's free flash model
- `hy3-preview-free` - Hy3 preview model
- `nemotron-3-super-free` - NVIDIA Nemotron free trial model
- `trinity-large-preview-free` - Trinity large preview model
- `deepseek-v4-flash-free` - DeepSeek's free fast open-source model (default)
- `mimo-v2.5-free` - Xiaomi's free long-context MiMo model
- `north-mini-code-free` - North's free coding model
- `nemotron-3-ultra-free` - NVIDIA Nemotron free trial model
- `big-pickle` - OpenCode stealth model
- `gpt-5-nano` - OpenAI's free lightweight GPT model

**Premium Models:**

- Claude Sonnet 4.6, Claude Opus 4.7, Claude Haiku 4.5
- Kimi K2.6, Kimi K2 Thinking
- DeepSeek V4 Pro
- GLM 5.1
- Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5, Claude Fable 5
- Kimi K2.6
- DeepSeek V4 Pro, DeepSeek V4 Flash
- GLM 5.2, GLM 5.1
- Qwen3.7 Max, Qwen3.7 Plus
- MiMo V2.5, MiMo V2.5 Pro
- MiniMax M2.7
- Gemini 3.1 Pro, Gemini 3 Flash
- Gemini 3.5 Flash, Gemini 3.1 Pro, Gemini 3 Flash
- GPT 5.5, GPT 5.5 Pro, GPT 5.4 Mini/Nano, GPT 5.3 Codex
- And more...

Expand All @@ -211,17 +211,14 @@ Get your API key at: https://opencode.ai/auth

Access to a wide variety of models from different providers.

**Free Models:**

- MiniMax M2.5 Free

**Premium Models:**
**Open-source and open-weight highlights:**

- MiMo V2.5, MiMo V2.5 Pro
- Kimi K2.6, Kimi K2 Thinking
- Kimi K2.7 Code, Kimi K2.6
- DeepSeek V4 Pro, DeepSeek V4 Flash
- GLM 5.1, GLM 5 Turbo
- MiniMax M2.7
- GLM 5.2, GLM 5.1, GLM 5 Turbo
- Qwen3.7 Max, Qwen3.7 Plus
- MiniMax M3, MiniMax M2.7
- MiMo V2.5, MiMo V2.5 Pro
- And many more...

Get your API key at: https://openrouter.ai/keys
Expand Down Expand Up @@ -303,7 +300,7 @@ Configuration is stored in `~/.magic-shell/config.json`.
```json
{
"provider": "opencode-zen",
"defaultModel": "minimax-m2.5-free",
"defaultModel": "deepseek-v4-flash-free",
"thinkingLevel": "low",
"safetyLevel": "moderate",
"dryRunByDefault": false,
Expand All @@ -326,11 +323,16 @@ Configuration is stored in `~/.magic-shell/config.json`.

### Environment Variables

| Variable | Description |
| ---------------------- | ----------------------------- |
| `OPENCODE_ZEN_API_KEY` | API key for OpenCode Zen |
| `OPENROUTER_API_KEY` | API key for OpenRouter |
| `DEBUG_API=1` | Enable API response debugging |
| Variable | Description |
| -------------------------------- | ----------------------------------- |
| `OPENCODE_ZEN_API_KEY` | API key for OpenCode Zen |
| `OPENROUTER_API_KEY` | API key for OpenRouter |
| `AI_GATEWAY_API_KEY` | API key for Vercel AI Gateway |
| `CLOUDFLARE_AI_GATEWAY_API_KEY` | API key/token for Cloudflare Gateway |
| `CLOUDFLARE_API_TOKEN` | API token for Workers AI |
| `CLOUDFLARE_ACCOUNT_ID` | Account ID for Cloudflare providers |
| `CLOUDFLARE_AI_GATEWAY_ID` | Gateway ID for Cloudflare Gateway |
| `DEBUG_API=1` | Enable API response debugging |

## Themes

Expand Down Expand Up @@ -583,6 +585,13 @@ MIT License - see [LICENSE](LICENSE) for details.

## Release Notes

### v0.2.22 - Model Catalog and Release Prep

- Refreshed OpenCode Zen and OpenRouter model registries with current June 2026 open-source/open-weight entries
- Updated the default free Zen model to `deepseek-v4-flash-free`
Comment thread
coderabbitai[bot] marked this conversation as resolved.
- Added Zen routing support for Qwen models on the Messages endpoint
- Updated release docs and website provider surfaces for the refreshed provider/model set

### v0.2.20 - Thinking Controls and Zen Free Models
- Added `--thinking <level>` and `thinkingLevel` config support (`off`, `low`, `medium`, `high`)
- Added provider-specific reasoning controls for supported OpenRouter, OpenCode Zen, gateway, and custom models
Expand Down
4 changes: 2 additions & 2 deletions website/SCHEMA-IMPLEMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ The website implements comprehensive JSON-LD structured data to help search engi

- Application category: DeveloperApplication
- Operating systems: macOS, Linux, Windows
- Version: 0.2.14
- Version: 0.2.22
- Price: Free ($0)
- Download URL (npm)
- Feature list (10 key features)
- Requirements: Node.js 18.0.0+
- Requirements: Bun 1.3.14+
- Code repository
- License: MIT
- Screenshots/images
Expand Down
8 changes: 4 additions & 4 deletions website/SCHEMA-SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,13 @@ Comprehensive schema.org structured data has been implemented for the Magic Shel
### SoftwareApplication Schema

- ✅ Free pricing ($0)
- ✅ Version 0.2.14
- ✅ Version 0.2.22
- ✅ Cross-platform (macOS, Linux, Windows)
- ✅ 10 feature highlights
- ✅ npm download link
- ✅ GitHub repository link
- ✅ MIT license
- ✅ Requirements (Node.js 18+)
- ✅ Requirements (Bun 1.3.14+)

### HowTo Schema

Expand Down Expand Up @@ -144,7 +144,7 @@ Comprehensive schema.org structured data has been implemented for the Magic Shel
- [ ] View page source and verify JSON-LD is present
- [ ] Check JSON syntax is valid (no trailing commas, proper quotes)
- [ ] Verify all URLs are fully qualified (https://mshell.dev/...)
- [ ] Confirm version number is current (0.2.14)
- [ ] Confirm version number is current (0.2.22)
- [ ] Review FAQ answers for accuracy

### After Deployment
Expand Down Expand Up @@ -265,7 +265,7 @@ Comprehensive schema.org structured data has been implemented for the Magic Shel

```astro
// In Schema.astro, line ~60
"softwareVersion": "0.2.14", // ← Update this
"softwareVersion": "0.2.22", // ← Update this
```

### Add FAQ Question
Expand Down
2 changes: 1 addition & 1 deletion website/SCHEMA-VALIDATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ schemas.forEach((s, i) => {
**Check for:**

- [ ] All URLs are fully qualified (https://mshell.dev/...)
- [ ] Version number matches current release (0.2.14)
- [ ] Version number matches current release (0.2.22)
- [ ] Feature list is accurate and up-to-date
- [ ] FAQ answers match actual functionality
- [ ] HowTo steps are clear and actionable
Expand Down
2 changes: 1 addition & 1 deletion website/TEST-SCHEMA.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ npm run preview
**SoftwareApplication:**

- ✅ Name: "Magic Shell"
- ✅ Version: "0.2.14"
- ✅ Version: "0.2.22"
- ✅ Price: "0"
- ✅ Operating systems listed
- ✅ 10 features in featureList
Expand Down
6 changes: 3 additions & 3 deletions website/src/components/FAQSchema.astro
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const faqSchema = {
"name": "What is Magic Shell?",
"acceptedAnswer": {
"@type": "Answer",
"text": "Magic Shell is an open-source CLI tool that translates natural language into shell commands using AI. It supports multiple AI providers (OpenCode Zen with free models, and OpenRouter), includes a beautiful interactive TUI mode, and features comprehensive safety analysis to protect against dangerous commands."
"text": "Magic Shell is an open-source CLI tool that translates natural language into shell commands using AI. It supports multiple AI providers (OpenCode Zen with free models, OpenRouter, Vercel AI Gateway, Cloudflare AI Gateway, Workers AI, and custom models), includes a beautiful interactive TUI mode, and features comprehensive safety analysis to protect against dangerous commands."
}
},
{
Expand All @@ -27,15 +27,15 @@ const faqSchema = {
"name": "Is Magic Shell free to use?",
"acceptedAnswer": {
"@type": "Answer",
"text": "Yes, Magic Shell is completely free and open-source under the MIT license. It supports free AI models through OpenCode Zen (including minimax-m2.5-free, ling-2.6-flash-free, hy3-preview-free, nemotron-3-super-free, trinity-large-preview-free, big-pickle, and gpt-5-nano) as well as premium models from various providers. You can also use custom local models with LM Studio or Ollama at no cost."
"text": "Yes, Magic Shell is completely free and open-source under the MIT license. It supports free AI models through OpenCode Zen (including deepseek-v4-flash-free, mimo-v2.5-free, north-mini-code-free, nemotron-3-ultra-free, big-pickle, and gpt-5-nano) as well as premium models from various providers. You can also use custom local models with LM Studio or Ollama at no cost."
}
},
{
"@type": "Question",
"name": "What AI providers does Magic Shell support?",
"acceptedAnswer": {
"@type": "Answer",
"text": "Magic Shell supports OpenCode Zen (recommended, with free models), OpenRouter, and custom OpenAI-compatible endpoints. You can also add custom models from LM Studio, Ollama, or any OpenAI-compatible API. Each provider offers different models with varying capabilities and pricing."
"text": "Magic Shell supports OpenCode Zen (recommended, with free models), OpenRouter, Vercel AI Gateway, Cloudflare AI Gateway, Workers AI, and custom OpenAI-compatible endpoints. You can also add custom models from LM Studio, Ollama, or any OpenAI-compatible API. Each provider offers different models with varying capabilities and pricing."
}
},
{
Expand Down
22 changes: 11 additions & 11 deletions website/src/components/Schema.astro
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ const organizationSchema = {
"logo": `${baseUrl}/favicon.svg`,
"description": "Transform natural language into terminal commands with AI-powered translation and built-in safety features",
"sameAs": [
"https://github.com/designxdevelop/magic-shell"
"https://github.com/austin-thesing/magic-shell"
],
"foundingDate": "2026",
"founder": {
"@type": "Person",
"name": "Austin Thesing",
"url": "https://github.com/designxdevelop/magic-shell"
"url": "https://github.com/austin-thesing"
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
};

Expand Down Expand Up @@ -59,10 +59,10 @@ const softwareSchema = type === 'homepage' ? {
"name": "Magic Shell",
"applicationCategory": "DeveloperApplication",
"operatingSystem": "macOS, Linux, Windows",
"description": "Open-source CLI tool that translates natural language into shell commands using AI. Supports multiple AI providers, includes a beautiful interactive TUI mode, and features comprehensive safety analysis.",
"description": "Open-source CLI tool that translates natural language into shell commands using AI. Supports OpenCode Zen, OpenRouter, AI gateways, Workers AI, and custom models.",
"url": baseUrl,
"downloadUrl": "https://www.npmjs.com/package/@austinthesing/magic-shell",
"softwareVersion": "0.2.14",
"softwareVersion": "0.2.22",
"offers": {
"@type": "Offer",
"price": "0",
Expand All @@ -71,15 +71,15 @@ const softwareSchema = type === 'homepage' ? {
"author": {
"@type": "Person",
"name": "Austin Thesing",
"url": "https://github.com/designxdevelop/magic-shell"
"url": "https://github.com/austin-thesing"
},
"publisher": {
"@id": `${baseUrl}/#organization`
},
"screenshot": `${baseUrl}/og-image.png`,
"featureList": [
"Natural language to terminal command translation",
"Multiple AI providers (OpenCode Zen, OpenRouter)",
"Multiple AI providers (OpenCode Zen, OpenRouter, AI gateways, Workers AI, custom models)",
"Interactive TUI mode with 8 themes",
"Command safety analysis with multi-level checks",
"Project context awareness",
Expand All @@ -89,13 +89,13 @@ const softwareSchema = type === 'homepage' ? {
"Command history tracking",
"Auto-update checking"
],
"requirements": "Node.js 18.0.0 or higher",
"requirements": "Bun 1.3.14 or higher",
"installUrl": `${baseUrl}/getting-started/installation/`,
"softwareHelp": {
"@type": "WebPage",
"url": `${baseUrl}/getting-started/installation/`
},
"codeRepository": "https://github.com/designxdevelop/magic-shell",
"codeRepository": "https://github.com/austin-thesing/magic-shell",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "TypeScript"
Expand All @@ -119,7 +119,7 @@ const howToSchema = type === 'homepage' ? {
"tool": [
{
"@type": "HowToTool",
"name": "Node.js or Bun runtime"
"name": "Bun runtime"
},
{
"@type": "HowToTool",
Expand All @@ -144,7 +144,7 @@ const howToSchema = type === 'homepage' ? {
"@type": "HowToStep",
"position": 2,
"name": "Configure API Key",
"text": "Set up your API key for OpenCode Zen or OpenRouter to enable AI-powered command translation",
"text": "Set up your API key for OpenCode Zen, OpenRouter, an AI gateway, Workers AI, or a custom provider to enable AI-powered command translation",
"itemListElement": [
{
"@type": "HowToDirection",
Expand Down Expand Up @@ -209,7 +209,7 @@ const articleSchema = type === 'article' && title ? {
"author": {
"@type": "Person",
"name": "Austin Thesing",
"url": "https://github.com/designxdevelop/magic-shell"
"url": "https://github.com/austin-thesing"
},
"publisher": {
"@id": `${baseUrl}/#organization`
Expand Down
6 changes: 3 additions & 3 deletions website/src/components/TransformHero.astro
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import InstallBlock from "./InstallBlock.astro";
<path d="M5 12h14M12 5l7 7-7 7"/>
</svg>
</a>
<a href="https://github.com/designxdevelop/magic-shell" class="btn btn-secondary" target="_blank" rel="noopener">
<a href="https://github.com/austin-thesing/magic-shell" class="btn btn-secondary" target="_blank" rel="noopener">
<svg width="16" height="16" viewBox="0 0 24 24" fill="currentColor">
<path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"/>
</svg>
Expand Down Expand Up @@ -82,13 +82,13 @@ import InstallBlock from "./InstallBlock.astro";
</div>
<span class="demo-title">magic-shell</span>
<div class="demo-header-right">
<span class="model-badge">grok-3</span>
<span class="model-badge">deepseek-v4-flash-free</span>
</div>
</div>
<div class="tui-body">
<div class="tui-status-bar">
<span class="status-item"><span class="status-key">Provider:</span> opencode-zen</span>
<span class="status-item"><span class="status-key">Model:</span> grok-3</span>
<span class="status-item"><span class="status-key">Model:</span> deepseek-v4-flash-free</span>
<span class="status-item mode-safe"><span class="status-dot"></span> Safe Mode</span>
</div>

Expand Down
Loading