@octavus/agent 0.2.0 → 0.3.1
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 +7 -3
- package/dist/index.js +69 -68
- package/dist/screen-publisher/index.js +4 -0
- package/package.json +4 -1
package/README.md
CHANGED
|
@@ -17,7 +17,7 @@ Then mint an agent API key from the agent's **Settings -> API** tab.
|
|
|
17
17
|
## Install
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
|
-
curl -fsSL https://octavus.ai/install/
|
|
20
|
+
curl -fsSL https://octavus.ai/install/agent-cli.sh | sh
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
The installer sets up the prerequisites a full computer needs on a standard Linux box (Node, a headless X display via Xvfb, the AT-SPI accessibility bus, Chrome for Testing) so "install and run" just works. A shell + filesystem only agent needs none of the display stack.
|
|
@@ -54,7 +54,11 @@ The working directory you launch in is the agent's workspace (override with `--w
|
|
|
54
54
|
- `octoagent config [--env <name>]` - show the current configuration.
|
|
55
55
|
- `octoagent version [--env <name>]` - show the CLI and platform-supported versions.
|
|
56
56
|
|
|
57
|
-
Exit codes: `0` completed, `1` failed, `2` bad usage, `3` update required.
|
|
57
|
+
Exit codes: `0` completed, `1` failed, `2` bad usage, `3` update required, `4` stopped from the dashboard.
|
|
58
|
+
|
|
59
|
+
### Stopping a run
|
|
60
|
+
|
|
61
|
+
A run has no live chat, but you can still stop it from the dashboard: open its thread and click **Stop**. The run is aborted on the machine and the CLI exits with code `4` (its `--json` output reports `"status": "cancelled"`). Useful when you fan out several runs from a server and want to halt some of them.
|
|
58
62
|
|
|
59
63
|
### Run configuration
|
|
60
64
|
|
|
@@ -81,7 +85,7 @@ Precedence: explicit flags > `--config` file > the agent's dashboard defaults. A
|
|
|
81
85
|
|
|
82
86
|
### Machine-readable output
|
|
83
87
|
|
|
84
|
-
`--json` prints exactly one JSON object to stdout - `{ "threadId", "sessionId", "status", "threadUrl" }` - with all human/progress output routed to stderr, so a benchmark harness can capture and correlate a run without scraping text. The exit code
|
|
88
|
+
`--json` prints exactly one JSON object to stdout - `{ "threadId", "sessionId", "status", "threadUrl" }` - with all human/progress output routed to stderr, so a benchmark harness can capture and correlate a run without scraping text. The exit code signals completed (`0`), failed (`1`), or stopped from the dashboard (`4`). Read the full transcript and a per-run cost/usage summary from `GET /api/v1/workforce/agents/{agentId}/threads/{threadId}` with the same agent key.
|
|
85
89
|
|
|
86
90
|
### Environments
|
|
87
91
|
|