@pleri/olam-cli 0.1.114 → 0.1.116

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 ADDED
@@ -0,0 +1,127 @@
1
+ # @pleri/olam-cli
2
+
3
+ Standalone CLI for [Olam](https://github.com/pleri/olam) — isolated
4
+ development worlds with thought-graph capture, autonomous Build, and
5
+ an MCP server for Claude Code.
6
+
7
+ ```sh
8
+ # Install
9
+ curl -fsSL https://olam.bar.dev/install | sh
10
+ # (or: npm install -g @pleri/olam-cli)
11
+
12
+ # Verify
13
+ olam --version
14
+ ```
15
+
16
+ The installer publishes from npmjs.org. Requires **Node.js ≥ 20** and
17
+ `npm`. Track the prerelease tag with `OLAM_CHANNEL=canary`.
18
+
19
+ ## Wire the MCP server into Claude Code
20
+
21
+ Olam ships an MCP server with `olam_create`, `olam_dispatch`,
22
+ `olam_destroy`, `olam_list`, `olam_status`, `olam_enter`, `olam_pr`,
23
+ `olam_observe`, `olam_lane_*`, and `olam_capture_view`. Three wiring
24
+ paths:
25
+
26
+ ### One command (recommended)
27
+
28
+ ```sh
29
+ olam mcp install # default --scope=user
30
+ olam mcp install --scope=project # writes to project .mcp.json
31
+ olam mcp uninstall # idempotent; symmetric
32
+ ```
33
+
34
+ Auto-detects whether `olam` is on PATH. If so, writes
35
+ `command: "olam"`. Otherwise falls back to
36
+ `command: "npx", args: ["-y", "@pleri/olam-cli", "mcp", "serve"]`.
37
+
38
+ ### Paste-in JSON
39
+
40
+ Drop into `~/.claude.json` (user scope) or a project's `.mcp.json`:
41
+
42
+ ```json
43
+ {
44
+ "mcpServers": {
45
+ "olam": {
46
+ "command": "npx",
47
+ "args": ["-y", "@pleri/olam-cli", "mcp", "serve"]
48
+ }
49
+ }
50
+ }
51
+ ```
52
+
53
+ If `olam` is already on PATH, `command: "olam", args: ["mcp", "serve"]`
54
+ is faster (no `npx` cold-start).
55
+
56
+ ### Marketplace alias
57
+
58
+ `olam --mcp` is a thin alias for `olam mcp serve`, matching the MCP
59
+ marketplace convention where snippets invoke `npx -y <pkg> --mcp`. The
60
+ two invocations produce identical stdio output.
61
+
62
+ ### Verify
63
+
64
+ ```sh
65
+ claude mcp list | grep olam
66
+ ```
67
+
68
+ Restart Claude Code; the `olam_*` tools surface automatically.
69
+
70
+ ## Bootstrap the world stack
71
+
72
+ ```sh
73
+ olam bootstrap # pull host-cp + auth + devbox; start services; auth login
74
+ olam bootstrap --with-smoke # also create a smoke-test world
75
+ olam bootstrap --skip-auth-login
76
+ olam bootstrap --registry ghcr.io/pleri
77
+ ```
78
+
79
+ What it does (digest-pinned, idempotent, parallel pulls, retries on
80
+ transient failure): see
81
+ [`docs/architecture/bootstrap.md`](https://github.com/pleri/olam/blob/main/docs/architecture/bootstrap.md).
82
+
83
+ State lands under `~/.olam/`:
84
+
85
+ - `~/.olam/auth-secret` — shared secret (`0600`) generated on first
86
+ `auth up`.
87
+ - `~/.olam/worlds/<world-id>/` — per-world worktree + thought DB.
88
+ - `~/.olam/worlds.db` — world registry.
89
+ - `~/.olam/upgrade.log` — JSONL audit log of `olam upgrade`.
90
+
91
+ ## Common commands
92
+
93
+ ```sh
94
+ olam create --name <slug> --task "<one-line goal>"
95
+ olam list
96
+ olam status <world>
97
+ olam enter <world> # cd into the world's host clone
98
+ olam dispatch <world> "<msg>"
99
+ olam observe <world> # tail the world's thought stream
100
+ olam pr <world> # open / inspect the world's PR
101
+ olam destroy <world>
102
+ ```
103
+
104
+ Full surface:
105
+
106
+ ```sh
107
+ olam --help
108
+ olam <command> --help
109
+ ```
110
+
111
+ ## Self-upgrade
112
+
113
+ ```sh
114
+ olam upgrade -y # pull latest digests; restart services
115
+ ```
116
+
117
+ JSONL audit log at `~/.olam/upgrade.log`.
118
+
119
+ ## Docs
120
+
121
+ - [Full README](https://github.com/pleri/olam#readme)
122
+ - [MCP wiring deep-dive](https://github.com/pleri/olam/blob/main/docs/architecture/mcp-as-npx-served.md)
123
+ - [Architecture index](https://github.com/pleri/olam/tree/main/docs/architecture)
124
+
125
+ ## License
126
+
127
+ See [LICENSE](https://github.com/pleri/olam/blob/main/LICENSE).
@@ -5,6 +5,6 @@
5
5
  "host-cp": "sha256:13a26950fea2917ebb268f7bda04fd54267ffe8e5ba4a550db89f28eb309553f",
6
6
  "mcp-auth": "sha256:c82fcfca7ed1b139cbea252697487889b96b45a6575cfba076de7f57eaa943ac",
7
7
  "$schema_version": 1,
8
- "$published_version": "0.1.114",
8
+ "$published_version": "0.1.116",
9
9
  "$registry": "ghcr.io/pleri"
10
10
  }