steward-cli 0.22.0 → 0.23.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 +34 -119
- package/dist/cli.js +661 -651
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,36 +1,16 @@
|
|
|
1
1
|
# Steward
|
|
2
2
|
|
|
3
|
-
[](https://bun.sh)
|
|
7
|
-
[](#get-started)
|
|
3
|
+
[](https://www.npmjs.com/package/steward-cli)
|
|
4
|
+
[](LICENSE)
|
|
5
|
+
[](#get-started)
|
|
8
6
|
|
|
9
|
-
Steward is an interactive AI engineering assistant
|
|
7
|
+
Steward is an interactive AI engineering assistant that lives in your terminal, understands your codebase, and pairs with you to build, refactor, and debug software through natural language.
|
|
10
8
|
|
|
11
9
|
---
|
|
12
10
|
|
|
13
11
|
## Get Started
|
|
14
12
|
|
|
15
|
-
###
|
|
16
|
-
|
|
17
|
-
Install Steward globally using npm or Bun:
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
# npm (Recommended)
|
|
21
|
-
npm install -g steward-cli
|
|
22
|
-
|
|
23
|
-
# Bun
|
|
24
|
-
bun add -g steward-cli
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
Or execute directly with npx:
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
npx steward-cli
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
#### Standalone Scripts
|
|
13
|
+
### Quick Install
|
|
34
14
|
|
|
35
15
|
**macOS, Linux & Termux:**
|
|
36
16
|
```bash
|
|
@@ -42,117 +22,52 @@ curl -fsSL https://raw.githubusercontent.com/sapirrior/steward/main/installer/in
|
|
|
42
22
|
irm https://raw.githubusercontent.com/sapirrior/steward/main/installer/install.ps1 | iex
|
|
43
23
|
```
|
|
44
24
|
|
|
45
|
-
**
|
|
25
|
+
**Package Managers:**
|
|
46
26
|
```bash
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
bun install
|
|
50
|
-
bun run start
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
## Core Capabilities
|
|
56
|
-
|
|
57
|
-
- **Human-in-the-Loop Engineering:** Steward keeps you in control with explicit permission gates for filesystem mutations and bash commands.
|
|
58
|
-
- **First-Class Local Model Support:** Optimized for local model execution (Ollama, LM Studio, vLLM, Qwen, DeepSeek) as well as cloud frontier APIs.
|
|
59
|
-
- **Lightweight Native Architecture:** Handcrafted zero-overhead runtime with sub-millisecond startup and minimal system resource usage.
|
|
60
|
-
- **Synchronized Terminal UI:** Built with Mode 2026 synchronized output, flicker-free differential rendering, and intra-line word diffs.
|
|
61
|
-
- **Lossless Rewind Checkpoints:** Every file mutation is automatically tracked with Content-Addressed Storage (CAS) hashes, allowing one-click turn rollbacks.
|
|
62
|
-
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
## Privacy & Data Security
|
|
66
|
-
|
|
67
|
-
Steward operates on a strictly local-first architecture:
|
|
68
|
-
|
|
69
|
-
- **Zero Telemetry:** Steward collects no analytics, tracking data, or diagnostic logs.
|
|
70
|
-
- **Local Persistence:** All session history, configuration, and state are stored locally on your machine.
|
|
71
|
-
- **Direct Inference:** Network requests are made directly to your configured provider or local server endpoint via your own API credentials, governed entirely by your provider's terms.
|
|
72
|
-
|
|
73
|
-
---
|
|
74
|
-
|
|
75
|
-
## Provider Setup & Configuration
|
|
76
|
-
|
|
77
|
-
Steward supports 11 local and cloud providers with native streaming, dynamic model discovery, and multi-turn tool calling. Configure via environment variables, `.env` file, or OAuth `/login`:
|
|
78
|
-
|
|
79
|
-
### OAuth & Device Code Login
|
|
80
|
-
|
|
81
|
-
Authenticate directly from the terminal without manual API key management:
|
|
82
|
-
|
|
83
|
-
```bash
|
|
84
|
-
# Authenticate with GitHub Copilot (Device Code flow)
|
|
85
|
-
/login github-copilot
|
|
86
|
-
|
|
87
|
-
# Authenticate with Anthropic or OpenRouter (Browser OAuth flow)
|
|
88
|
-
/login anthropic
|
|
89
|
-
/login openrouter
|
|
27
|
+
# npm
|
|
28
|
+
npm install -g steward-cli
|
|
90
29
|
|
|
91
|
-
#
|
|
92
|
-
|
|
30
|
+
# Bun
|
|
31
|
+
bun add -g steward-cli
|
|
93
32
|
```
|
|
94
33
|
|
|
95
|
-
###
|
|
96
|
-
|
|
97
|
-
```bash
|
|
98
|
-
# Ollama
|
|
99
|
-
export OLLAMA_BASE_URL="http://localhost:11434"
|
|
100
|
-
export OLLAMA_MODEL="qwen2.5-coder:32b"
|
|
101
|
-
|
|
102
|
-
# Generic OpenAI-Compatible Endpoint (LM Studio, vLLM, LocalAI)
|
|
103
|
-
export CUSTOM_API_URL="http://localhost:1234/v1"
|
|
104
|
-
export CUSTOM_API_MODEL_NAME="qwen2.5-coder-32b-instruct"
|
|
105
|
-
export CUSTOM_API_KEY="optional-api-key"
|
|
106
|
-
```
|
|
34
|
+
### Usage
|
|
107
35
|
|
|
108
|
-
|
|
36
|
+
Navigate to any project directory and run:
|
|
109
37
|
|
|
110
38
|
```bash
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
# Google Gemini
|
|
115
|
-
export GEMINI_API_KEY="AIzaSy..."
|
|
116
|
-
|
|
117
|
-
# OpenAI
|
|
118
|
-
export OPENAI_API_KEY="sk-..."
|
|
39
|
+
steward
|
|
40
|
+
```
|
|
119
41
|
|
|
120
|
-
|
|
121
|
-
export DEEPSEEK_API_KEY="sk-..."
|
|
42
|
+
Authenticate with your provider of choice using `/login` (Anthropic, OpenRouter, GitHub Copilot) or standard API keys.
|
|
122
43
|
|
|
123
|
-
|
|
124
|
-
export GROQ_API_KEY="gsk_..."
|
|
44
|
+
---
|
|
125
45
|
|
|
126
|
-
|
|
127
|
-
export XAI_API_KEY="xai-..."
|
|
46
|
+
## Supported Providers & Models
|
|
128
47
|
|
|
129
|
-
|
|
130
|
-
export MISTRAL_API_KEY="your-mistral-api-key"
|
|
48
|
+
Steward natively connects to frontier APIs, gateways, and local offline inference servers:
|
|
131
49
|
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
50
|
+
| Provider | Authentication | Default Model | Key / Config |
|
|
51
|
+
| :--- | :--- | :--- | :--- |
|
|
52
|
+
| **Anthropic** | Browser OAuth / API Key | `claude-3-7-sonnet-20250219` | `/login anthropic` or `ANTHROPIC_API_KEY` |
|
|
53
|
+
| **OpenAI** | API Key | `gpt-4o-mini` | `OPENAI_API_KEY` |
|
|
54
|
+
| **Google Gemini** | API Key | `gemini-2.5-flash` | `GEMINI_API_KEY` |
|
|
55
|
+
| **OpenRouter** | Browser OAuth / API Key | `meta-llama/llama-3.3-70b-instruct:free` | `/login openrouter` or `OPENROUTER_API_KEY` |
|
|
56
|
+
| **GitHub Copilot** | Device Code OAuth | `gpt-4o` | `/login github-copilot` |
|
|
57
|
+
| **Ollama (Local)** | None | `qwen2.5-coder:latest` | `OLLAMA_BASE_URL` (default `http://localhost:11434/v1`) |
|
|
58
|
+
| **DeepSeek** | API Key | `deepseek-chat` | `DEEPSEEK_API_KEY` |
|
|
59
|
+
| **Groq** | API Key | `llama-3.3-70b-versatile` | `GROQ_API_KEY` |
|
|
60
|
+
| **xAI / Grok** | API Key | `grok-2-1212` | `XAI_API_KEY` |
|
|
61
|
+
| **Mistral AI** | API Key | `codestral-latest` | `MISTRAL_API_KEY` |
|
|
62
|
+
| **Custom** | Optional API Key | `default` | `CUSTOM_API_URL` & `CUSTOM_API_KEY` |
|
|
135
63
|
|
|
136
64
|
---
|
|
137
65
|
|
|
138
|
-
##
|
|
139
|
-
|
|
140
|
-
| Command | Description |
|
|
141
|
-
| :--- | :--- |
|
|
142
|
-
| `/login` | Authenticate with cloud providers (`anthropic`, `openrouter`, `github-copilot`) |
|
|
143
|
-
| `/logout` | Log out from authenticated providers and clear stored credentials |
|
|
144
|
-
| `/model` | Switch active model or discover available models across providers |
|
|
145
|
-
| `/mode` | Cycle through or set active chat mode (`normal`, `chat`, `review`, `build`) |
|
|
146
|
-
| `/theme` | Change terminal color theme (`dark`, `light`, `dracula`, `dark-ansi`, `light-ansi`) |
|
|
147
|
-
| `/effort` | Adjust model reasoning effort level (`none`, `low`, `medium`, `high`) |
|
|
148
|
-
| `/rewind` | Revert workspace modifications and conversation state to any prior turn |
|
|
149
|
-
| `/sessions` | Browse, resume, or delete saved session transcripts |
|
|
150
|
-
| `/clear` | Clear the current conversation and start a new session |
|
|
151
|
-
| `/help` | View help manual and keyboard shortcuts |
|
|
152
|
-
| `/exit` | Exit Steward (`Ctrl+C Ctrl+C`) |
|
|
66
|
+
## Contributing
|
|
153
67
|
|
|
154
|
-
|
|
68
|
+
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
|
|
155
69
|
|
|
156
70
|
## License
|
|
157
71
|
|
|
158
72
|
MIT License © 2026 [sapirrior](https://github.com/sapirrior)
|
|
73
|
+
|