orka-cli 1.0.1 → 1.0.2

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.
Files changed (2) hide show
  1. package/README.md +8 -64
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -25,9 +25,6 @@ $ orka run "build user authentication with OAuth2 and JWT"
25
25
  - **Parallel multi-agent swarm** — Coordinator + Scout + N Builders + Reviewer work concurrently
26
26
  - **Zero file conflicts** — atomic SQLite file ownership locks prevent two agents from editing the same file
27
27
  - **AI self-healing loop** — TesterAgent runs your test suite after each build; if tests fail, Builder retries with the test output as feedback
28
- - **Human gate** — optionally require human approval before any task is marked done, with a full diff preview
29
- - **Web dashboard** — built-in HTTP server with real-time WebSocket updates; monitor and control sessions from any browser
30
- - **Remote access** — built-in Cloudflare Tunnel support (`--tunnel`) for iPad/remote access without VPN
31
28
  - **Provider-agnostic** — Claude, OpenAI, Gemini, Ollama (local/free), OpenRouter — mix and match per role
32
29
  - **Git integration** — auto-branch per session, auto-commit after approval, safe rollback
33
30
  - **Crash recovery** — full state persisted in SQLite; `orka resume` picks up exactly where it left off
@@ -57,31 +54,6 @@ orka login --provider claude
57
54
  orka run "add input validation to all API endpoints"
58
55
  ```
59
56
 
60
- ## Web Dashboard (Mission Control)
61
-
62
- Run Orka as a persistent server and control everything from your browser — no terminal needed after startup.
63
-
64
- ```bash
65
- # Start the server (point --static to the GUI build)
66
- orka serve --project /path/to/your-project --static /path/to/gui/dist
67
-
68
- # With Cloudflare Tunnel for iPad/remote access
69
- orka serve --project /path/to/your-project --static /path/to/gui/dist --tunnel
70
- # → 🌐 Tunnel URL: https://xxxxx.trycloudflare.com
71
- ```
72
-
73
- From the dashboard you can:
74
- - **Start new sessions** — type a goal and click Run
75
- - **Monitor agents** — real-time swarm canvas with task status
76
- - **Review diffs** — click any `AWAITING APPROVAL` task to see the full git diff
77
- - **Approve or reject** — with optional feedback sent back to the Builder
78
-
79
- Alternatively, run server + session together in one command:
80
-
81
- ```bash
82
- orka run "your goal" --serve --serve-static /path/to/gui/dist [--tunnel]
83
- ```
84
-
85
57
  ## Configuration
86
58
 
87
59
  `orka init` generates `orka.config.yaml` in your project root:
@@ -97,7 +69,6 @@ swarm:
97
69
  builders: 2 # number of parallel Builder agents
98
70
  review: true # enable Reviewer agent
99
71
  maxReviewRetries: 3
100
- humanGate: false # set true to require human approval before done
101
72
 
102
73
  roles:
103
74
  coordinator: { provider: claude, model: claude-sonnet-4-20250514 }
@@ -139,22 +110,6 @@ roles:
139
110
  reviewer: { provider: claude, model: claude-sonnet-4-20250514 }
140
111
  ```
141
112
 
142
- ## Human Gate (Approval Workflow)
143
-
144
- Enable `humanGate: true` in your config to require human review before any task is finalized.
145
-
146
- **Pipeline with human gate:**
147
- ```
148
- Builder → TesterAgent → ReviewerAgent → awaiting_approval → [you approve] → done
149
- ↘ [you reject] → Builder retries
150
- ```
151
-
152
- When a task reaches `awaiting_approval`:
153
- - The web dashboard shows a purple **APPROVE** badge
154
- - Click the task to open a diff preview modal
155
- - Click **Approve** to finalize, or **Reject** with optional feedback
156
- - On rejection, the Builder retries with your feedback as context
157
-
158
113
  ## Self-Healing Test Loop
159
114
 
160
115
  Enable `tester.enabled: true` to have Orka automatically run your test suite after each build:
@@ -202,8 +157,6 @@ orka run "goal" --builders 4 # use 4 parallel Builder agents
202
157
  orka run "goal" --provider claude # override all roles to one provider
203
158
  orka run "goal" --dry-run # preview plan without calling any LLM
204
159
  orka run "goal" --mock # use mock provider (no API calls, for testing)
205
- orka run "goal" --serve # start HTTP server alongside the session
206
- orka run "goal" --serve --tunnel # + expose via Cloudflare Tunnel
207
160
  orka pause # pause all agents gracefully
208
161
  orka resume # resume from pause or crash
209
162
  orka rollback # rollback last session branch to base commit
@@ -221,15 +174,6 @@ orka logs --type task:completed # filter by message type
221
174
  orka cost # show token usage and cost summary
222
175
  ```
223
176
 
224
- ### Web Server
225
- ```bash
226
- orka serve # start HTTP server + web dashboard
227
- orka serve --port 8080 # custom port (default: 4242)
228
- orka serve --project /path/to/project # set project directory
229
- orka serve --static /path/to/gui/dist # serve web dashboard
230
- orka serve --tunnel # expose via Cloudflare Tunnel
231
- ```
232
-
233
177
  ### Provider & Credentials
234
178
  ```bash
235
179
  orka login --provider claude # save Claude API key
@@ -300,14 +244,14 @@ After all tasks are approved, Orka auto-commits to the session branch. You decid
300
244
 
301
245
  ## Supported Providers
302
246
 
303
- | Provider | Models | Notes |
304
- |----------|--------|-------|
305
- | **Claude** | claude-sonnet-4, claude-haiku-4-5, ... | Best quality |
306
- | **OpenAI** | gpt-4o, gpt-4o-mini, o1, ... | |
307
- | **Gemini** | gemini-2.0-flash, gemini-1.5-pro, ... | |
308
- | **Ollama** | llama3, deepseek-coder-v2, qwen2.5-coder, ... | Free, runs locally |
309
- | **OpenRouter** | Any model via OpenRouter | |
310
- | **Zai / GLM** | glm-4, ... | |
247
+ | Provider | Notes |
248
+ |----------|-------|
249
+ | **Claude** | Best quality for planning and review |
250
+ | **OpenAI** | GPT-4o, o1, and variants |
251
+ | **Gemini** | Gemini 2.0 Flash, 1.5 Pro |
252
+ | **Ollama** | Free, runs locally — llama3, deepseek-coder-v2, qwen2.5-coder |
253
+ | **OpenRouter** | Access any model via OpenRouter |
254
+ | **Zai / GLM** | GLM-4 and variants |
311
255
 
312
256
  ## MCP Integration
313
257
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "orka-cli",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Multi-agent orchestration CLI",
5
5
  "type": "module",
6
6
  "bin": {