steward-cli 0.11.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/LICENSE +21 -0
- package/README.md +144 -0
- package/dist/cli.js +122904 -0
- package/package.json +47 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 sapirrior
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
# Steward
|
|
2
|
+
|
|
3
|
+
[](https://github.com/sapirrior/steward/releases)
|
|
4
|
+
[](https://www.npmjs.com/package/steward-cli)
|
|
5
|
+
[](LICENSE)
|
|
6
|
+
[](https://bun.sh)
|
|
7
|
+
[](#get-started)
|
|
8
|
+
|
|
9
|
+
Steward is an interactive AI engineering assistant for the terminal. Built with a lightweight native runtime, Steward pairs with you to explore codebases, refactor architectures, run commands, and implement features with full human-in-the-loop control across local and frontier models.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
```text
|
|
14
|
+
▄▄▄▄▄ Steward
|
|
15
|
+
▀▙███▟▀ AI engineering assistant for your terminal
|
|
16
|
+
▘▘ ▝▝
|
|
17
|
+
|
|
18
|
+
────────────────────────────────────────────────────────────────────────────────
|
|
19
|
+
> Refactor the authentication service to use JWT refresh token rotation
|
|
20
|
+
────────────────────────────────────────────────────────────────────────────────
|
|
21
|
+
? for shortcuts claude-3-7-sonnet
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Get Started
|
|
27
|
+
|
|
28
|
+
### Installation
|
|
29
|
+
|
|
30
|
+
Install Steward globally using npm or Bun:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# npm (Recommended)
|
|
34
|
+
npm install -g steward-cli
|
|
35
|
+
|
|
36
|
+
# Bun
|
|
37
|
+
bun add -g steward-cli
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Or execute directly with npx:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx steward-cli
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### Standalone Scripts
|
|
47
|
+
|
|
48
|
+
**macOS, Linux & Termux:**
|
|
49
|
+
```bash
|
|
50
|
+
curl -fsSL https://raw.githubusercontent.com/sapirrior/steward/main/installer/install.sh | bash
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
**Windows (PowerShell):**
|
|
54
|
+
```powershell
|
|
55
|
+
irm https://raw.githubusercontent.com/sapirrior/steward/main/installer/install.ps1 | iex
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Build from Source:**
|
|
59
|
+
```bash
|
|
60
|
+
git clone https://github.com/sapirrior/steward.git
|
|
61
|
+
cd steward
|
|
62
|
+
bun install
|
|
63
|
+
bun run start
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Core Capabilities
|
|
69
|
+
|
|
70
|
+
- **Human-in-the-Loop Engineering:** Steward keeps you in control with explicit permission gates for filesystem mutations and bash commands.
|
|
71
|
+
- **First-Class Local Model Support:** Optimized for local model execution (Ollama, LM Studio, vLLM, Qwen, DeepSeek) as well as cloud frontier APIs.
|
|
72
|
+
- **Lightweight Native Architecture:** Handcrafted zero-overhead runtime with sub-millisecond startup and minimal system resource usage.
|
|
73
|
+
- **Synchronized Terminal UI:** Built with Mode 2026 synchronized output, flicker-free differential rendering, and intra-line word diffs.
|
|
74
|
+
- **Hands-Free Voice Dictation:** Toggle `Ctrl+T` to dictate complex instructions with real-time speech-to-text directly in the prompt editor.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Privacy & Data Security
|
|
79
|
+
|
|
80
|
+
Steward operates on a strictly local-first architecture:
|
|
81
|
+
|
|
82
|
+
- **Zero Telemetry:** Steward collects no analytics, tracking data, or diagnostic logs.
|
|
83
|
+
- **Local Persistence:** All session history, configuration, and state are stored locally on your machine.
|
|
84
|
+
- **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.
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## Provider Setup & Configuration
|
|
89
|
+
|
|
90
|
+
Steward supports local endpoints and major cloud providers. Configure your environment using environment variables or a `.env` file:
|
|
91
|
+
|
|
92
|
+
### Local Models (Ollama, LM Studio, vLLM)
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
export CUSTOM_API_URL="http://localhost:11434/v1"
|
|
96
|
+
export CUSTOM_API_MODEL_NAME="qwen2.5-coder:32b"
|
|
97
|
+
export CUSTOM_API_KEY="ollama"
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Cloud Providers
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
# Anthropic
|
|
104
|
+
export ANTHROPIC_API_KEY="sk-ant-..."
|
|
105
|
+
|
|
106
|
+
# Google Gemini
|
|
107
|
+
export GEMINI_API_KEY="AIzaSy..."
|
|
108
|
+
|
|
109
|
+
# OpenAI
|
|
110
|
+
export OPENAI_API_KEY="sk-..."
|
|
111
|
+
|
|
112
|
+
# DeepSeek
|
|
113
|
+
export DEEPSEEK_API_KEY="sk-..."
|
|
114
|
+
|
|
115
|
+
# xAI
|
|
116
|
+
export XAI_API_KEY="xai-..."
|
|
117
|
+
|
|
118
|
+
# Mistral AI
|
|
119
|
+
export MISTRAL_API_KEY="your-mistral-api-key"
|
|
120
|
+
|
|
121
|
+
# OpenRouter
|
|
122
|
+
export OPENROUTER_API_KEY="sk-or-v1-..."
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## Slash Commands
|
|
128
|
+
|
|
129
|
+
| Command | Description |
|
|
130
|
+
| :--- | :--- |
|
|
131
|
+
| `/rewind` | Revert workspace modifications and conversation state to any prior turn |
|
|
132
|
+
| `/model` | Switch active model or provider endpoint |
|
|
133
|
+
| `/effort` | Adjust model reasoning effort level |
|
|
134
|
+
| `/clear` | Clear the current conversation and start a new session |
|
|
135
|
+
| `/resume` | Browse and resume a prior session |
|
|
136
|
+
| `/rename` | Rename the active session |
|
|
137
|
+
| `/skills` | List discovered workspace skills |
|
|
138
|
+
| `/exit` | Exit Steward (`Ctrl+C Ctrl+C`) |
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
## License
|
|
143
|
+
|
|
144
|
+
MIT License © 2026 [sapirrior](https://github.com/sapirrior)
|