orchestrai 0.1.12 → 0.1.13

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 +45 -11
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,20 +1,44 @@
1
1
  # orchestrai
2
2
 
3
- Run OrchestrAI — a local, terminal-oriented multi-agent DevOps orchestration prototype — with nothing pre-installed:
3
+ Run OrchestrAI — a local, terminal-oriented multi-agent DevOps orchestration prototype — with nothing pre-installed. No Bun, no clone, no separate download step: the right platform binary installs automatically as part of this package (an optional dependency scoped to your OS/architecture).
4
+
5
+ ## Install
4
6
 
5
7
  ```
6
- npx orchestrai --project /path/to/your/project
8
+ npm install -g orchestrai@latest
7
9
  ```
8
10
 
9
- or, with Bun:
11
+ (pin a specific version instead of `@latest` any time you want a reproducible install — see [Reproducibility](#reproducibility) below.)
12
+
13
+ ## Set up your project, once
14
+
15
+ ```
16
+ orchestrai init
17
+ ```
18
+
19
+ Walks you through the target project path, which of the 5 agents to run, and whether to enable the optional LLM planning harness (provider/model/API key). Answer once — it's saved per project, in a `.orchestrai/` folder next to where you run it.
20
+
21
+ ## Run it
22
+
23
+ ```
24
+ orchestrai
25
+ ```
26
+
27
+ Starts the full local stack — 5 specialist agents (planning, DevOps, testing, documentation, security), an MCP tool server, and an orchestrator that routes work between them — then opens a **dashboard at [http://localhost:3000/dashboard](http://localhost:3000/dashboard)**. That's where you submit tasks and watch them run. In a real terminal it also opens an interactive terminal viewer alongside the dashboard.
28
+
29
+ ## Prefer a one-shot run instead?
10
30
 
11
31
  ```
12
- bunx orchestrai --project /path/to/your/project
32
+ npx orchestrai@latest --project /path/to/your/project
13
33
  ```
14
34
 
15
- No Bun, no clone, no separate download step — the right platform binary installs automatically as part of this package (an optional dependency scoped to your OS/architecture), and this command just runs it.
35
+ or, with Bun:
36
+
37
+ ```
38
+ bunx orchestrai@latest --project /path/to/your/project
39
+ ```
16
40
 
17
- `orchestrai` starts the full local stack — 5 specialist agents (planning, DevOps, testing, documentation, security), an MCP tool server, and an orchestrator that routes work between them — then opens a **dashboard at [http://localhost:3000/dashboard](http://localhost:3000/dashboard)**. That's where you submit tasks and watch them run.
41
+ Skips the global install and the saved per-project setup — useful for a quick one-off run, but `init` is the better path if you'll run it against the same project more than once.
18
42
 
19
43
  ## Supported platforms
20
44
 
@@ -36,22 +60,32 @@ xattr -d com.apple.quarantine "$(which orchestrai)"
36
60
 
37
61
  (or the equivalent path npm installed it under) before running it again.
38
62
 
39
- ## Usage
63
+ ## All flags
40
64
 
41
65
  ```
42
66
  orchestrai # start everything, interactively in a real terminal
43
67
  orchestrai init # interactive setup wizard, run once per project
44
- orchestrai --project "/path/to/app"
68
+ orchestrai --project "/path/to/app" # override the saved/inferred target path for this run
45
69
  orchestrai --only devops-agent # start a subset of services (comma-separated)
46
70
  orchestrai --headless # backend only, plain logs — no interactive viewer
47
71
  orchestrai --help
48
72
  ```
49
73
 
50
- `orchestrai init` walks you through target path, which services to run, and whether to enable the optional LLM planning harness (provider/model/API key) — answer once, and a plain `orchestrai` afterward reuses that setup with no flags needed.
51
-
52
74
  ## Reproducibility
53
75
 
54
- Each published version of this package corresponds to a specific, immutable build — pinning a version (`npx orchestrai@1.2.3`) always resolves the identical binary, not a rolling "latest."
76
+ Each published version of this package corresponds to a specific, immutable build. Pin a version instead of `@latest` any time you want that guarantee:
77
+
78
+ ```
79
+ npm install -g orchestrai@0.1.12
80
+ ```
81
+
82
+ or for the one-shot form:
83
+
84
+ ```
85
+ npx orchestrai@0.1.12 --project /path/to/your/project
86
+ ```
87
+
88
+ Either always resolves the identical binary, not a rolling "latest."
55
89
 
56
90
  ## Source
57
91
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "orchestrai",
3
- "version": "0.1.12",
3
+ "version": "0.1.13",
4
4
  "description": "OrchestrAI — run the standalone orchestrai binary via bunx/npx with nothing pre-installed. The right platform binary is installed automatically as an optional dependency; no network download at runtime.",
5
5
  "license": "MIT",
6
6
  "bin": {