You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 10331e5
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: assets/commands/omnara.md
+19-9Lines changed: 19 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,7 +69,7 @@ Hosted API requests go to `https://api.omnara.com/v1` and browser login uses `ht
69
69
> Print the authenticated user and their organizations.
70
70
71
71
**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 activitystate is running, waiting on interaction, idle, or archived.
73
73
74
74
**machines** (alias **machine**)
75
75
> 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
110
110
> Inline YAML or JSON agent config.
111
111
112
112
**--config**_id_
113
-
> Existing agent config ID (`acfg_…`).
113
+
> Existing agent config ID (prefix `acfg-`).
114
114
115
115
**--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.
117
117
118
118
**--message**_text_
119
119
> 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
127
127
# CONFIGURATION
128
128
129
129
**~/.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
+
```
131
141
132
142
An agent config is YAML or JSON. A minimal hosted-cloud example:
133
143
@@ -147,13 +157,13 @@ On Omnara Cloud the first project includes provider `omnara-openrouter` and pool
147
157
# ENVIRONMENT
148
158
149
159
**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.
151
161
152
162
**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.
154
164
155
165
**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.
157
167
158
168
**OMNARA_API_URL**
159
169
> 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
163
173
164
174
# CAVEATS
165
175
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.
167
177
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.
169
179
170
180
Archiving an agent deletes its integration subscriptions, stops work, drops queued inputs, and releases pooled machines. Machines you connected yourself, configs, and profiles remain.
Copy file name to clipboardExpand all lines: assets/commands/omnarad.md
+17-4Lines changed: 17 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,10 +97,23 @@ The usual install path is the hosted script `https://api.omnara.com/install/omna
97
97
> Daemon home. **OMNARA_HOME** must be an absolute, already-clean path. Default is `~/.omnarad`.
98
98
99
99
**~/.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
+
```
101
114
102
115
**~/.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.
104
117
105
118
**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.
106
119
@@ -113,7 +126,7 @@ The usual install path is the hosted script `https://api.omnara.com/install/omna
113
126
> Control-plane API root written into `daemon.json`. Default `https://api.omnara.com/v1`.
114
127
115
128
**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.
117
130
118
131
**OMNARA_NO_UPDATE**
119
132
> `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
130
143
131
144
**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.
132
145
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.
0 commit comments