@knowttl/artium-axi 0.0.24 → 0.0.26
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 +120 -285
- package/bin/artium-axi.mjs +2037 -84
- package/package.json +1 -1
- package/skill/artium-axi/SKILL.md +96 -3
package/package.json
CHANGED
|
@@ -3,8 +3,8 @@ name: artium-axi
|
|
|
3
3
|
description: Discover and run managed commands through Artium, using the signed-in account and its granted tools.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
Run `artium-axi
|
|
6
|
+
For requests involving data from Artium-managed tools, discover the tools available to this account before choosing one.
|
|
7
|
+
Run `artium-axi` for identity and tools together, or `artium-axi tools` when only tool discovery is needed.
|
|
8
8
|
Run `artium-axi tools show <tool>` for its commands and a vetted example, then run `artium-axi <tool> <args>`.
|
|
9
9
|
Follow the returned next commands; they already include the Artium prefix.
|
|
10
10
|
Keep upstream arguments intact and use the managed credentials rather than configuring an upstream CLI directly.
|
|
@@ -17,8 +17,101 @@ On Windows, choose the labelled PowerShell or Git Bash command for your shell.
|
|
|
17
17
|
The setup command records the standalone bundle's Node invocation here.
|
|
18
18
|
<!-- /artium-axi executable -->
|
|
19
19
|
|
|
20
|
-
If sign-in is required, ask the user to
|
|
20
|
+
If sign-in is required, ask the user to sign in with their SSO or local account.
|
|
21
21
|
Never request or print tokens or put passwords in arguments.
|
|
22
22
|
An empty tool list means no enabled runtime tool is available through the account's roles; ask an administrator to check grants and enabled tools.
|
|
23
23
|
Use `artium-axi doctor` for connection or cached health diagnostics.
|
|
24
24
|
Do not retry an uncertain command outcome, especially a write.
|
|
25
|
+
|
|
26
|
+
## Investigation quick guide
|
|
27
|
+
|
|
28
|
+
Start with these reads using an already signed-in account, without running help first.
|
|
29
|
+
Artium is a managed transport; vendor investigation syntax and one-call pivots belong to the tool skills installed by setup.
|
|
30
|
+
Use the matching installed skill once you know the granted tool.
|
|
31
|
+
|
|
32
|
+
| Read command and example | What it answers |
|
|
33
|
+
| --- | --- |
|
|
34
|
+
| `artium-axi` | Identity, roles and available tools together in one call. |
|
|
35
|
+
| `artium-axi tools` | Granted enabled tools, status, pinned version and `readOnly`; no flags required. |
|
|
36
|
+
| `artium-axi tools show falcon-axi` | One tool's reviewed command inventory, vetted upstream help and first read example; substitute a granted tool name. |
|
|
37
|
+
| `artium-axi whoami` | Identity, roles, session expiry and server; no flags required. |
|
|
38
|
+
| `artium-axi doctor` | Connection, certificate, token, version and cached tool health; does not run a fresh upstream credential test. |
|
|
39
|
+
| `artium-axi falcon-axi detection list` | First endpoint detection read when Falcon is granted; keep all upstream arguments after the tool name. |
|
|
40
|
+
|
|
41
|
+
The home view combines identity and tool discovery, so skip separate whoami and tools calls when it already answers the question.
|
|
42
|
+
Tools show combines command inventory, vetted help and a first call, avoiding help probes for every listed command.
|
|
43
|
+
Artium has no generic batch, start-and-wait, list-with-details or lookup-and-pivot flag.
|
|
44
|
+
Use only single-call forms documented by the granted tool's installed skill and supported by its pinned command inventory; upstream support does not imply managed availability.
|
|
45
|
+
|
|
46
|
+
### Keep output small
|
|
47
|
+
|
|
48
|
+
Client discovery has no `--fields`, `--limit` or `--full` flags.
|
|
49
|
+
Tools already returns only `name`, `status`, `version` and `readOnly`; use tools show for one tool's details only when needed.
|
|
50
|
+
Forward tool-specific filters, `--fields` and `--limit` only where its skill documents them.
|
|
51
|
+
Prefer identifiers, status, timestamps and summary fields; fetch long descriptions only for relevant records.
|
|
52
|
+
Upstream `--full`, where supported, restores text but never bypasses redaction, execution budgets or output caps.
|
|
53
|
+
Heed stderr truncation notices and narrow the query rather than treating partial output as complete; see [output limits](https://github.com/knowttl/artium-axi/blob/main/docs/client-reference.md#toon-output-behavior).
|
|
54
|
+
|
|
55
|
+
### Help is recovery
|
|
56
|
+
|
|
57
|
+
Use help for a command that fails or whose arguments are unclear, not to start an investigation.
|
|
58
|
+
`artium-axi --help` returns the local client command list, usage, flags and an example without signing in.
|
|
59
|
+
Client command help, such as `artium-axi tools --help`, `artium-axi tools show --help`, `artium-axi whoami --help` and `artium-axi doctor --help`, describes only that client command.
|
|
60
|
+
`artium-axi --help falcon-axi` is local entry help describing forwarding and managed boundaries.
|
|
61
|
+
`artium-axi falcon-axi --help` and `artium-axi falcon-axi detection list --help` authenticate and forward help to the pinned tool at the requested level.
|
|
62
|
+
The same before/after-tool distinction applies to other granted tools.
|
|
63
|
+
|
|
64
|
+
### Read allowlist and state changes
|
|
65
|
+
|
|
66
|
+
The six reads above are candidates for a reviewed allowlist, scoped to their exact argument forms.
|
|
67
|
+
Authenticated reads can refresh local session tokens and create server audit records.
|
|
68
|
+
Never allow an unrestricted tool prefix merely because its discovery row says `readOnly`.
|
|
69
|
+
Login, passwd and logout change session/account state; setup writes skills/hooks; update replaces the executable; download prepares transfers or saves artifacts.
|
|
70
|
+
Forwarded writes and job creation need separate review and administrator enablement where supported.
|
|
71
|
+
Hybrid Analysis quick scans can transmit samples or URLs even with managed writes disabled.
|
|
72
|
+
Native preview, execute and exact confirmation gates still apply; there is no universal Artium confirmation flag.
|
|
73
|
+
|
|
74
|
+
### Failures and next action
|
|
75
|
+
|
|
76
|
+
Artium errors are TOON on stdout with `error.code`, `source`, `message` and `next`; follow `next` rather than retrying blindly.
|
|
77
|
+
For a non-zero tool exit, keep the stderr `artium-axi: request_id <id>` line and quote that ID, the tool and time when asking an administrator for help; never include credentials or sensitive output.
|
|
78
|
+
Follow the [failed-call troubleshooting path](https://github.com/knowttl/artium-axi/blob/main/docs/runbook.md#troubleshoot-a-failed-tool-call) for administrator investigation, and check current state before retrying an unknown write outcome.
|
|
79
|
+
See the [output contract](https://github.com/knowttl/artium-axi/blob/main/README.md#toon-output-and-errors) for exit codes and upstream output handling.
|
|
80
|
+
|
|
81
|
+
Use the [generated error reference](https://github.com/knowttl/artium-axi/blob/main/docs/errors.md) for code-specific recovery and exit codes.
|
|
82
|
+
See the [credential diagnostic guidance](https://github.com/knowttl/artium-axi/blob/main/docs/runbook.md#scripted-administrator-sessions) for tool-code mappings and administrator troubleshooting.
|
|
83
|
+
|
|
84
|
+
## Commands
|
|
85
|
+
|
|
86
|
+
This table is kept identical to the [command reference](https://github.com/knowttl/artium-axi/blob/main/docs/commands.md).
|
|
87
|
+
Tool reference links describe upstream commands; Artium controls availability, credentials and permissions.
|
|
88
|
+
|
|
89
|
+
| Command | Purpose |
|
|
90
|
+
| --- | --- |
|
|
91
|
+
| `artium-axi` | Show identity, roles and available tools. |
|
|
92
|
+
| `artium-axi --help [<command>]` | Show local client or tool-entry help without authentication. |
|
|
93
|
+
| `artium-axi --version` | Print the client package version. |
|
|
94
|
+
| `artium-axi login --username <username> [--password-stdin]` | Sign in with a local account using protected password input. |
|
|
95
|
+
| `artium-axi login --sso` | Sign in through browser approval of the terminal code. |
|
|
96
|
+
| `artium-axi passwd [--password-stdin]` | Change the account password, then sign in again. |
|
|
97
|
+
| `artium-axi logout` | Remove local tokens and attempt server-session revocation. |
|
|
98
|
+
| `artium-axi whoami` | Show identity, roles, session expiry and server. |
|
|
99
|
+
| `artium-axi tools` | List granted enabled tools with status and pinned versions. |
|
|
100
|
+
| `artium-axi tools show <tool>` | Show one available tool, vetted upstream help and a first call. |
|
|
101
|
+
| `artium-axi doctor` | Check the server, certificate, token, client version and cached tool health. |
|
|
102
|
+
| `artium-axi update` | Download and verify the server client, replace this file and retain a .bak backup; npm installs use npm instead. |
|
|
103
|
+
| `artium-axi download --operation <operation> --selector <selector> --type <type> --destination <absolute-new-path> [--transfer <id> --execute --confirm <exact-confirm>] [--password-stdin\|--sso]` | Preview or explicitly verify and save administrator-enabled Hybrid Analysis archives, Check Point emails/attachments, Graph mail exports or BeyondTrust endpoint content; see `artium-axi download --help` for guards. |
|
|
104
|
+
| `artium-axi setup --host <claude\|codex\|opencode\|pi> [--hook] [--force]` | Install skills for the signed-in account's granted tools and an optional Claude Code hook. |
|
|
105
|
+
| `artium-axi --managed-session <command> [<args>]` | Supply and persist caller-owned sessions through private pipes; see `artium-axi --managed-session --help`. |
|
|
106
|
+
| `artium-axi falcon-axi [<args>]` | Run Falcon commands with managed credentials; [tool reference](https://github.com/knowttl/falcon-axi#readme). |
|
|
107
|
+
| `artium-axi vectra-axi [<args>]` | Run Vectra commands with managed credentials; [tool reference](https://www.npmjs.com/package/@knowttl/vectra-axi). |
|
|
108
|
+
| `artium-axi az-axi [<args>]` | Run Azure commands with the managed identity; [tool reference](https://www.npmjs.com/package/@knowttl/az-axi). |
|
|
109
|
+
| `artium-axi mg-axi [<args>]` | Run Microsoft Graph commands with the managed identity; [tool reference](https://www.npmjs.com/package/@knowttl/mg-axi). |
|
|
110
|
+
| `artium-axi ldap-axi [<args>]` | Read directory data with the managed LDAP bind identity; [tool reference](https://www.npmjs.com/package/@knowttl/ldap-axi). |
|
|
111
|
+
| `artium-axi ado-axi [<args>]` | Run Azure DevOps commands with managed credentials; [tool reference](https://www.npmjs.com/package/@jeffreyhaen/ado-axi). |
|
|
112
|
+
| `artium-axi awx-axi [<args>]` | Inspect AWX automation with managed credentials; [tool reference](https://www.npmjs.com/package/awx-axi). |
|
|
113
|
+
| `artium-axi tenable-axi [<args>]` | Investigate Tenable One with managed API keys; [tool reference](https://www.npmjs.com/package/@knowttl/tenable-axi). |
|
|
114
|
+
| `artium-axi hybrid-axi [<args>]` | Investigate Hybrid Analysis with a managed API key; [tool reference](https://www.npmjs.com/package/@knowttl/hybrid-axi). |
|
|
115
|
+
| `artium-axi beyondtrust-axi [<args>]` | Inspect BeyondTrust PM Cloud Endpoint Privilege Management with managed credentials; [tool reference](https://www.npmjs.com/package/@knowttl/beyondtrust-axi). |
|
|
116
|
+
| `artium-axi checkpoint-axi [<args>]` | Investigate Check Point Email Security with managed regional credentials; [tool reference](https://www.npmjs.com/package/@knowttl/checkpoint-axi). |
|
|
117
|
+
| `artium-axi gh-axi [<args>]` | Read and update GitHub data with managed credentials; [tool reference](https://www.npmjs.com/package/gh-axi). |
|