@knowttl/artium-axi 0.0.9 → 0.0.11
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 +25 -16
- package/bin/artium-axi.mjs +2623 -1014
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -35,17 +35,18 @@ Agents keep a command-line interface with TOON discovery rather than implementin
|
|
|
35
35
|
- **Limits:** reviewed command inventories, write switches, bounded runtime, output and concurrency.
|
|
36
36
|
|
|
37
37
|
### Supported pinned tools
|
|
38
|
-
| Tool |
|
|
39
|
-
| --- | --- |
|
|
40
|
-
| Falcon |
|
|
41
|
-
| Vectra |
|
|
42
|
-
| Azure |
|
|
43
|
-
| Microsoft Graph |
|
|
44
|
-
| LDAP |
|
|
45
|
-
| Azure DevOps |
|
|
46
|
-
| AWX |
|
|
47
|
-
|
|
48
|
-
|
|
38
|
+
| Tool | Managed access |
|
|
39
|
+
| --- | --- |
|
|
40
|
+
| Falcon | API client; optional guarded RTR read-only commands |
|
|
41
|
+
| Vectra | Token or OAuth; optional allow-listed writes |
|
|
42
|
+
| Azure | Application identity and resource-token broker |
|
|
43
|
+
| Microsoft Graph | Application identity; optional allow-listed writes |
|
|
44
|
+
| LDAP | Verified TLS simple bind; read-only |
|
|
45
|
+
| Azure DevOps | PAT or application identity |
|
|
46
|
+
| AWX | Pasted token or one-time password sign-in; optional operational writes |
|
|
47
|
+
| Tenable One | Access and secret API keys; optional allow-listed business writes and export jobs |
|
|
48
|
+
|
|
49
|
+
[Package pins](tools/package.json) and the [Falcon source pin](tools/falcon-source.json) own bundled versions; [reviewed inventories](tools/inventories) define the supported command boundary.
|
|
49
50
|
|
|
50
51
|
## Quickstart
|
|
51
52
|
|
|
@@ -95,6 +96,10 @@ artium-axi falcon-axi detection list
|
|
|
95
96
|
Replace the synthetic username with your account; login uses a hidden terminal password prompt.
|
|
96
97
|
For `PASSWORD_CHANGE_REQUIRED`, run `artium-axi passwd`, then log in again.
|
|
97
98
|
For SSO, use `artium-axi login --sso` and approve only the browser code matching your own terminal.
|
|
99
|
+
After ordinary login, later commands, installed hooks and skills use [saved connection settings](docs/client-reference.md#client-settings).
|
|
100
|
+
After a server upgrade, run `artium-axi update`, then `artium-axi --version`.
|
|
101
|
+
The updater uses those connection settings, verifies the server download’s SHA-256, replaces the running client file and keeps the previous client beside it as `<client-file>.bak`.
|
|
102
|
+
The client file and its directory must be writable.
|
|
98
103
|
The Falcon read requires an enabled tool, a role grant and API permissions; choose the example from an available tool's detail view.
|
|
99
104
|
|
|
100
105
|
With no enabled tools granted, `artium-axi tools` succeeds with:
|
|
@@ -117,6 +122,7 @@ artium-axi login --username synthetic-user
|
|
|
117
122
|
```
|
|
118
123
|
|
|
119
124
|
Login warns about version differences; minimum server API requirements still apply.
|
|
125
|
+
`artium-axi update` refuses npm installations; update them with `npm install -g @knowttl/artium-axi@latest`.
|
|
120
126
|
Install `@knowttl/artium-axi@<server-version>` or download from the server to match it.
|
|
121
127
|
|
|
122
128
|
### Build from source
|
|
@@ -156,11 +162,13 @@ Administrator capability alone grants no tool access; upstream permissions remai
|
|
|
156
162
|
|
|
157
163
|
| Tool | Write capability and unlock |
|
|
158
164
|
| --- | --- |
|
|
159
|
-
| Falcon
|
|
165
|
+
| Falcon | Optional guarded RTR execution from the standard read-only command allowlist, with profile narrowing. Host changes, scripts and file transfers remain unavailable. See [Falcon execution setup](docs/runbook.md#falcon-rtr-execution). |
|
|
166
|
+
| LDAP | Fixed read-only. |
|
|
160
167
|
| Azure | Reviewed resource mutations; administrator `allowWrites: true` plus native command gates. |
|
|
161
168
|
| Graph, Vectra | Native mutations only with administrator `writes.allowWrites: true` and an explicit operations allow-list, plus native gates. |
|
|
162
169
|
| Azure DevOps | Reviewed mutations with administrator `allowWrites: true`; raw `api` remains GET-only. |
|
|
163
170
|
| AWX | Launch/cancel/relaunch, workflow approval/denial, project/inventory-source sync and notification tests with `allowWrites: true` and upstream `--confirm`; configuration, deletion and security writes stay blocked. |
|
|
171
|
+
| Tenable One | Business writes and export-job creation with administrator `writes.allowWrites: true`, an explicit operations allow-list, native preview, `--execute`, exact `--confirm` and durable journaling; downloads and local configuration stay blocked. |
|
|
164
172
|
|
|
165
173
|
There is no universal Artium confirmation flag.
|
|
166
174
|
Use authenticated tool help and the [write-access runbook](docs/runbook.md#roles-credentials-and-health) for operation-specific gates.
|
|
@@ -175,6 +183,7 @@ After an unknown write outcome, inspect state using returned guidance before ret
|
|
|
175
183
|
| LDAP | Bind identity with directory read access |
|
|
176
184
|
| Azure DevOps project list | Identity permitted to view the organization/project |
|
|
177
185
|
| AWX job list | Token identity with job read access |
|
|
186
|
+
| Tenable One card list | See [Tenable One credential permissions](docs/tool-credentials.md#tenable-one). |
|
|
178
187
|
|
|
179
188
|
See [tool credentials](docs/tool-credentials.md) for dedicated identities, permissions and safe credential entry.
|
|
180
189
|
Artium stores shared service credentials encrypted with AES-256-GCM and never returns saved secrets to clients.
|
|
@@ -191,8 +200,7 @@ Its restricted environment, private directories and process limits are not a com
|
|
|
191
200
|
|
|
192
201
|
| Setting or flag | Purpose |
|
|
193
202
|
| --- | --- |
|
|
194
|
-
| `ARTIUM_AXI_URL` |
|
|
195
|
-
| `ARTIUM_AXI_CA_FILE` | Additional readable PEM trust bundle for the client |
|
|
203
|
+
| `ARTIUM_AXI_URL`, `ARTIUM_AXI_CA_FILE` | Connection overrides; see [client settings](docs/client-reference.md#client-settings) |
|
|
196
204
|
| `XDG_CONFIG_HOME` | Linux session-storage base, default `~/.config` |
|
|
197
205
|
| `--password-stdin` | Login/new password via protected stdin |
|
|
198
206
|
| `--host`, `--hook`, `--force` | Setup host, optional Claude hook, explicit skill replacement |
|
|
@@ -212,11 +220,12 @@ This summary follows the [CLI help registry](src/cli/help.ts); `artium-axi --hel
|
|
|
212
220
|
| `artium-axi` | Identity, roles and available tools |
|
|
213
221
|
| `login --username <username>` / `login --sso` | Local password / browser approval |
|
|
214
222
|
| `passwd` / `logout` | Change password / remove local tokens and attempt revocation |
|
|
215
|
-
| `whoami` | Identity, roles, expiry and server |
|
|
223
|
+
| `whoami` | Identity, roles, [session and access-token expiry](docs/client-reference.md#toon-output-behavior) and server |
|
|
216
224
|
| `tools` / `tools show <tool>` | Granted enabled tools / pinned help and first call |
|
|
217
225
|
| `doctor` | Server, TLS, token, version and cached health; five-second request deadlines |
|
|
226
|
+
| `update` | Update the [server-downloaded client](#verified-client) |
|
|
218
227
|
| `setup --host <host>` | Install managed skills and optional Claude hook |
|
|
219
|
-
| `<tool> <args>` | Run any of the
|
|
228
|
+
| `<tool> <args>` | Run any of the eight managed tools above |
|
|
220
229
|
| `--managed-session --help` | Private-pipe session protocol |
|
|
221
230
|
|
|
222
231
|
`artium-axi --help falcon-axi` is local help; `artium-axi falcon-axi --help` authenticates and calls upstream.
|