@austinthesing/magic-shell 0.1.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -25
- package/dist/cli.js +1724 -194
- package/dist/index.js +2154 -400
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,8 +8,10 @@ Magic Shell is an open-source CLI tool that translates plain English (or any nat
|
|
|
8
8
|
|
|
9
9
|
- **Natural Language Translation**: Describe what you want to do in plain English
|
|
10
10
|
- **Multiple AI Providers**: OpenCode Zen (with free models!) and OpenRouter
|
|
11
|
+
- **Project Context Aware**: Opt-in detection of package.json scripts, Makefile targets, etc.
|
|
11
12
|
- **Interactive TUI Mode**: Full-featured terminal interface with themes
|
|
12
13
|
- **Command Safety Analysis**: Multi-level safety checks before executing commands
|
|
14
|
+
- **Auto Updates**: Automatic update checking with one-command upgrades
|
|
13
15
|
- **Cross-Platform**: macOS, Linux, and Windows support
|
|
14
16
|
- **Shell-Aware**: Automatically detects and adapts to your shell (bash, zsh, fish, PowerShell, etc.)
|
|
15
17
|
- **Secure Credential Storage**: Uses system keychain (macOS Keychain, Linux secret-tool, Windows Credential Manager)
|
|
@@ -18,38 +20,20 @@ Magic Shell is an open-source CLI tool that translates plain English (or any nat
|
|
|
18
20
|
|
|
19
21
|
## Installation
|
|
20
22
|
|
|
21
|
-
###
|
|
23
|
+
### Via Package Manager (Recommended)
|
|
22
24
|
|
|
23
|
-
**macOS / Linux:**
|
|
24
25
|
```bash
|
|
25
|
-
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
**Windows (PowerShell):**
|
|
29
|
-
```powershell
|
|
30
|
-
irm https://raw.githubusercontent.com/austin-thesing/magic-shell/main/install.ps1 | iex
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
### Via Package Manager
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
# Install globally with bun (recommended)
|
|
26
|
+
# bun (recommended)
|
|
37
27
|
bun add -g @austinthesing/magic-shell
|
|
38
28
|
|
|
39
|
-
#
|
|
29
|
+
# npm
|
|
40
30
|
npm install -g @austinthesing/magic-shell
|
|
41
31
|
|
|
42
|
-
#
|
|
43
|
-
yarn global add @austinthesing/magic-shell
|
|
44
|
-
|
|
45
|
-
# Or with pnpm
|
|
32
|
+
# pnpm
|
|
46
33
|
pnpm add -g @austinthesing/magic-shell
|
|
47
|
-
```
|
|
48
34
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
```bash
|
|
52
|
-
brew install austin-thesing/tap/magic-shell
|
|
35
|
+
# yarn
|
|
36
|
+
yarn global add @austinthesing/magic-shell
|
|
53
37
|
```
|
|
54
38
|
|
|
55
39
|
### From Source
|
|
@@ -118,6 +102,10 @@ msh
|
|
|
118
102
|
| `msh --provider <name>` | Set provider (opencode-zen or openrouter) |
|
|
119
103
|
| `msh --themes` | List available themes |
|
|
120
104
|
| `msh --theme <name>` | Set color theme |
|
|
105
|
+
| `msh --repo-context` | Enable project context detection |
|
|
106
|
+
| `msh -r <query>` | Use project context for single query |
|
|
107
|
+
| `msh --version` | Show version |
|
|
108
|
+
| `msh --check-update` | Check for updates |
|
|
121
109
|
| `msh --help` | Show help |
|
|
122
110
|
|
|
123
111
|
### Examples
|
|
@@ -160,6 +148,7 @@ All shortcuts use the `Ctrl+X` chord (press Ctrl+X, then the key):
|
|
|
160
148
|
| `Ctrl+X S` | Switch provider |
|
|
161
149
|
| `Ctrl+X D` | Toggle dry-run mode |
|
|
162
150
|
| `Ctrl+X T` | Change theme |
|
|
151
|
+
| `Ctrl+X R` | Toggle project context |
|
|
163
152
|
| `Ctrl+X H` | Show history |
|
|
164
153
|
| `Ctrl+X C` | Show config |
|
|
165
154
|
| `Ctrl+X L` | Clear output |
|
|
@@ -257,9 +246,10 @@ Configuration is stored in `~/.magic-shell/config.json`.
|
|
|
257
246
|
```json
|
|
258
247
|
{
|
|
259
248
|
"provider": "opencode-zen",
|
|
260
|
-
"defaultModel": "
|
|
249
|
+
"defaultModel": "gemini-3-flash",
|
|
261
250
|
"safetyLevel": "moderate",
|
|
262
251
|
"dryRunByDefault": false,
|
|
252
|
+
"repoContext": false,
|
|
263
253
|
"theme": "opencode",
|
|
264
254
|
"blockedCommands": [...],
|
|
265
255
|
"confirmedDangerousPatterns": [...]
|