overlord-cli 0.2609280950.0 → 0.2610050824.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 +27 -5
- package/dist/connectors/adapters/antigravity/conformance-manifest.yaml +1 -1
- package/dist/connectors/adapters/claude/conformance-manifest.yaml +1 -1
- package/dist/connectors/adapters/codex/conformance-manifest.yaml +1 -1
- package/dist/connectors/adapters/cursor/conformance-manifest.yaml +1 -1
- package/dist/connectors/adapters/opencode/conformance-manifest.yaml +1 -1
- package/dist/connectors/adapters/pi/conformance-manifest.yaml +1 -1
- package/dist/index.js +2118 -1011
- package/dist/index.js.map +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,6 +31,7 @@ queue operations all reach persistence through the backend URL you configure —
|
|
|
31
31
|
### First run
|
|
32
32
|
|
|
33
33
|
Install the published package:
|
|
34
|
+
|
|
34
35
|
```bash
|
|
35
36
|
npm install -g --no-fund overlord-cli
|
|
36
37
|
```
|
|
@@ -86,10 +87,10 @@ Configuration lives in `overlord.toml` — a per-instance, uncommitted file
|
|
|
86
87
|
discovered from the current directory upward, or in `~/.ovld/overlord.toml` for a
|
|
87
88
|
global install.
|
|
88
89
|
|
|
89
|
-
| Mode
|
|
90
|
-
|
|
|
91
|
-
| **Local backend**
|
|
92
|
-
| **Hosted backend** | `backend_url` | `ovld config set cloud <url>`
|
|
90
|
+
| Mode | Config key | How to set it |
|
|
91
|
+
| ------------------ | ------------- | ------------------------------------------------------------------- |
|
|
92
|
+
| **Local backend** | `backend_url` | `ovld config set local [url]` — defaults to `http://127.0.0.1:4310` |
|
|
93
|
+
| **Hosted backend** | `backend_url` | `ovld config set cloud <url>` |
|
|
93
94
|
|
|
94
95
|
`ovld config set` without arguments opens the interactive backend selector.
|
|
95
96
|
`ovld config list` shows the resolved target; `ovld doctor` checks that the
|
|
@@ -98,7 +99,7 @@ backend is reachable.
|
|
|
98
99
|
Environment overrides (useful in scripts and CI):
|
|
99
100
|
|
|
100
101
|
- `OVLD_HOME` — relocate the entire global `~/.ovld` data directory (SQLite, object storage, objective ledgers, and native-session caches)
|
|
101
|
-
- `OVERLORD_BACKEND_URL` — production/global backend target; an
|
|
102
|
+
- `OVERLORD_BACKEND_URL` — production/global backend target; an _explicit_ runtime value (shell export, container/launcher injection) takes precedence over the resolved `overlord.toml` `backend_url`
|
|
102
103
|
- `OVERLORD_BACKEND_URL_DEV` — **development-only** backend target, read solely by the in-repo source build and the dev/test tooling that runs it (`yarn dev`, the test harness). An installed/published `ovld` never reads it, and nothing aliases it into the production `OVERLORD_BACKEND_URL`
|
|
103
104
|
- `OVERLORD_WEB_PORT` — port the local backend binds when launched
|
|
104
105
|
- `OVERLORD_USER_TOKEN` / `OVLD_USER_TOKEN` / `USER_TOKEN` — bearer token sent to the backend when set (checked in that order; takes precedence over stored credentials)
|
|
@@ -139,6 +140,27 @@ Both the desktop app and the CLI authenticate to `/api/*` with a bearer token:
|
|
|
139
140
|
previously stored the raw 7-day Better Auth session token, which is why they
|
|
140
141
|
expired far sooner than cloud logins.)
|
|
141
142
|
|
|
143
|
+
For an external automation that files missions in selected projects, create a
|
|
144
|
+
project automation token:
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
ovld user-token create --label "Feedback importer" \
|
|
148
|
+
--scope project-automation --project <project-id> --no-expiry
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
Repeat `--project` to select more projects. The token can read those projects
|
|
152
|
+
and create missions with initial objectives using `ovld protocol create
|
|
153
|
+
--project-id <project-id> --objectives-json '[{"objective":"..."}]'` or
|
|
154
|
+
`POST /api/missions`. The project default status applies when `statusId` is
|
|
155
|
+
omitted, and the mission is unassigned unless `assignedWorkspaceUserId` is
|
|
156
|
+
supplied. The token label appears as **Created via token** on its missions and
|
|
157
|
+
remains there after rename or revocation. The default expiry is 90 days;
|
|
158
|
+
`--no-expiry` disables it. Read the project's missions before creating a new
|
|
159
|
+
one on retry, since create has no idempotency key. This preset cannot manage
|
|
160
|
+
webhooks or call `prompt`, `record-work`, `add-objectives`, session, or launch
|
|
161
|
+
commands. Its exact REST and protocol route allowlist is in the
|
|
162
|
+
[authentication guide](../docs/src/content/docs/authentication-and-permissions.mdx).
|
|
163
|
+
|
|
142
164
|
For the **local** backend, desktop and CLI share `~/.ovld/auth.json`:
|
|
143
165
|
|
|
144
166
|
- Signing in through the desktop app writes the session bearer to `auth.json`, so
|