Skip to content

Commit 10331e5

Browse files
committed
Fix omnara and omnarad markup
1 parent fedb9d0 commit 10331e5

2 files changed

Lines changed: 36 additions & 13 deletions

File tree

‎assets/commands/omnara.md‎

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Hosted API requests go to `https://api.omnara.com/v1` and browser login uses `ht
6969
> Print the authenticated user and their organizations.
7070
7171
**agents** (alias **agent**)
72-
> Launch and manage agents. Subcommands: **list**, **get** _agent-id_, **launch**, **update** _agent-id_, **cancel** _agent-id_, **archive** _agent-id_, **mcp-add** _agent-id_, **chat** [_agent-id_], **input** _agent-id_, **events**, **interactions**. **launch** takes **--file**, **--source**, **--config**, and/or **--profile**, plus **--name** and **--message**. **chat** needs an interactive terminal. **input** sends **--message** or **--content-blocks**; **--delivery-mode** is `queued` or `steering`. **events list** / **events stream** read the timeline; **stream** accepts **--after-sequence** and **--deltas**. **cancel** stops the current turn; **archive** retires the agent (no unarchive). Agent `activity.state` is `running`, `waiting_on_interaction`, `idle`, or `archived`.
72+
> Launch and manage agents. Subcommands: **list**, **get** _agent-id_, **launch**, **update** _agent-id_, **cancel** _agent-id_, **archive** _agent-id_, **mcp-add** _agent-id_, **chat** [_agent-id_], **input** _agent-id_, **events**, **interactions**. **launch** takes **--file**, **--source**, **--config**, and/or **--profile**, plus **--name** and **--message**. **chat** needs an interactive terminal. **input** sends **--message** or **--content-blocks**; **--delivery-mode** is `queued` or `steering`. **events list** / **events stream** read the timeline; **stream** accepts **--after-sequence** and **--deltas**. **cancel** stops the current turn; **archive** retires the agent (no unarchive). Agent activity state is running, waiting on interaction, idle, or archived.
7373
7474
**machines** (alias **machine**)
7575
> Manage BYO machines. **create-local** creates a machine, mints a daemon token, and installs **omnarad** on this computer (**--display-name** required). It refuses if `~/.omnarad` (or **OMNARA_HOME**) already holds a daemon; run **omnarad uninstall** first. **create** prints a one-time token and install command for another computer. Also **list**, **get**, **update**, **delete**.
@@ -110,10 +110,10 @@ Hosted API requests go to `https://api.omnara.com/v1` and browser login uses `ht
110110
> Inline YAML or JSON agent config.
111111
112112
**--config** _id_
113-
> Existing agent config ID (`acfg_…`).
113+
> Existing agent config ID (prefix `acfg-`).
114114
115115
**--profile** _id_
116-
> Agent profile ID (`aprf_…`). Runs that profile's current config unless a config is also given.
116+
> Agent profile ID (prefix `aprf-`). Runs that profile's current config unless a config is also given.
117117
118118
**--message** _text_
119119
> First user message on **launch**, or a single text block on **agents input**.
@@ -127,7 +127,17 @@ Hosted API requests go to `https://api.omnara.com/v1` and browser login uses `ht
127127
# CONFIGURATION
128128

129129
**~/.config/omnara/config.json**
130-
> Saved token, default organization, default project, and API URLs. The directory is created mode `0700` and the file is written mode `0600`. Keys: `token`, `org_id`, `project_id`, `api_url`, `issuer_url`. A legacy `base_url` key is dropped on load.
130+
> Saved token, default organization, default project, and API URLs. The directory is created mode `0700` and the file is written mode `0600`. A legacy base-url key is dropped on load.
131+
132+
```
133+
{
134+
"token": "",
135+
"org_id": "",
136+
"project_id": "",
137+
"api_url": "",
138+
"issuer_url": ""
139+
}
140+
```
131141

132142
An agent config is YAML or JSON. A minimal hosted-cloud example:
133143

@@ -147,13 +157,13 @@ On Omnara Cloud the first project includes provider `omnara-openrouter` and pool
147157
# ENVIRONMENT
148158

149159
**OMNARA_API_KEY**
150-
> Bearer token. Overrides the token in the config file. The REST docs also show `OMNARA_TOKEN` for curl and the SDK; the CLI reads **OMNARA_API_KEY**.
160+
> Bearer token. Overrides the token in the config file. Curl and the SDK use a similarly named token variable; the CLI reads this one.
151161
152162
**OMNARA_ORG_ID**
153-
> Default organization ID. Overrides `org_id` in the config file.
163+
> Default organization ID. Overrides the organization key in the config file.
154164
155165
**OMNARA_PROJECT_ID**
156-
> Default project ID. Overrides `project_id` in the config file.
166+
> Default project ID. Overrides the project key in the config file.
157167
158168
**OMNARA_API_URL**
159169
> API root used for requests. Default `https://api.omnara.com/v1`. Self-hosted example: `http://localhost:8000/api/v1`.
@@ -163,9 +173,9 @@ On Omnara Cloud the first project includes provider `omnara-openrouter` and pool
163173
164174
# CAVEATS
165175

166-
Requires Node.js 22 or later. **agents chat** and **config select** need an interactive terminal. Without a saved token and without a TTY, commands fail with `not logged in: run 'omnara login' or set OMNARA_API_KEY`. **logout** does not revoke the token on the server.
176+
Requires Node.js 22 or later. **agents chat** and **config select** need an interactive terminal. Without a saved token and without a TTY, commands fail with: not logged in; run **omnara login** or set **OMNARA_API_KEY**. **logout** does not revoke the token on the server.
167177

168-
**machines create-local** will not overwrite an existing daemon home. Public resource IDs use a type prefix (`agt_`, `acfg_`, `aprf_`, `mch_`, `org_`, `proj_`, …) plus 26 lowercase base32 characters; treat them as opaque.
178+
**machines create-local** will not overwrite an existing daemon home. Public resource IDs use a type prefix (agt, acfg, aprf, mch, org, proj, and others) plus 26 lowercase base32 characters; treat them as opaque.
169179

170180
Archiving an agent deletes its integration subscriptions, stops work, drops queued inputs, and releases pooled machines. Machines you connected yourself, configs, and profiles remain.
171181

‎assets/commands/omnarad.md‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,23 @@ The usual install path is the hosted script `https://api.omnara.com/install/omna
9797
> Daemon home. **OMNARA_HOME** must be an absolute, already-clean path. Default is `~/.omnarad`.
9898
9999
**~/.omnarad/daemon.json**
100-
> Runtime config, mode `0600`. Fields include `schema_version`, `api_url` (default `https://api.omnara.com/v1`), `machine_token`, `installation_id`, `machine_id`, `no_update`, `runner_path`, and `git_credentials_disabled`.
100+
> Runtime config, mode `0600`. Default API root is `https://api.omnara.com/v1`.
101+
102+
```
103+
{
104+
"schema_version": 1,
105+
"api_url": "https://api.omnara.com/v1",
106+
"machine_token": "",
107+
"installation_id": "",
108+
"machine_id": "",
109+
"no_update": false,
110+
"runner_path": "",
111+
"git_credentials_disabled": false
112+
}
113+
```
101114

102115
**~/.omnarad/install.json**
103-
> Install receipt (`schema_version`, `install_method` `omnarad.sh`, `release_manifest_url`) used for repairs and background updates.
116+
> Install receipt used for repairs and background updates: schema version, install method `omnarad.sh`, and the release manifest URL.
104117
105118
**omnara machines create-local** refuses to run when this home already holds a daemon install. Run **omnarad uninstall** first to connect the computer as a new machine.
106119

@@ -113,7 +126,7 @@ The usual install path is the hosted script `https://api.omnara.com/install/omna
113126
> Control-plane API root written into `daemon.json`. Default `https://api.omnara.com/v1`.
114127
115128
**OMNARA_MACHINE_TOKEN**
116-
> One-time machine token (`omnara_daemon_v1_…`). Required at install if not prompted interactively. A rejected token is reported against the configured API URL.
129+
> One-time machine token (prefix `omnara-daemon-v1-`). Required at install if not prompted interactively. A rejected token is reported against the configured API URL.
117130
118131
**OMNARA_NO_UPDATE**
119132
> `1` disables background updates; `0` enables them. Other values are an error.
@@ -130,7 +143,7 @@ Installer coverage is macOS and Linux on amd64 and arm64. macOS binaries require
130143

131144
**status** exits **1** when the daemon is stopped, so it is not a success-only health check in scripts. Hidden internal subcommands (`run-service`, process runner, file transfer, git credential helper) are used by the service manager and agent runtime; they are not user commands.
132145

133-
The daemon connects outbound only. Grant the machine to a project with **omnara grant machines add** (or pass **--project-ids** at create) before agent configs can target it by `machine_name`.
146+
The daemon connects outbound only. Grant the machine to a project with **omnara grant machines add** (or pass **--project-ids** at create) before agent configs can target it by machine name.
134147

135148
# HISTORY
136149

0 commit comments

Comments
 (0)