@knowttl/artium-axi 0.0.27 → 0.0.29

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 CHANGED
@@ -16,6 +16,9 @@ Administrators deploy and configure the server; client users sign in and discove
16
16
  ## Quickstart
17
17
 
18
18
  Use Linux with Node **24.11.0+** and a trusted HTTPS server URL and account from your administrator.
19
+ The npm package installs only the client: an administrator must separately [deploy the Artium server](docs/admin-guide.md#set-up-a-host), configure authentication and grant your account access to enabled tools.
20
+ The client host needs DNS and outbound HTTPS connectivity to that server, plus trust in its TLS certificate chain.
21
+ No vendor credentials belong on the client host.
19
22
 
20
23
  ```sh
21
24
  npm install --global @knowttl/artium-axi
@@ -42,20 +45,25 @@ See [verified server downloads and updates](docs/client-reference.md#verified-cl
42
45
 
43
46
  ## Use with your agent
44
47
 
45
- After sign-in, install managed skills and the optional Claude Code discovery hook:
48
+ After sign-in on Linux, explicitly install managed skills and optional ambient session context for your host:
46
49
 
47
50
  ```sh
48
51
  artium-axi setup --host claude --hook
52
+ artium-axi setup --host codex --hook
53
+ artium-axi setup --host opencode --hook
49
54
  ```
50
55
 
51
- For Codex, OpenCode or Pi, use `--host codex`, `--host opencode` or `--host pi` without `--hook`.
52
- The Claude `SessionStart` hook injects `tools` output; skills teach managed command discovery and grant no permissions.
56
+ Choose your host's command; omit `--hook` to install skills only, including `--host pi`.
57
+ Claude Code and Codex use `SessionStart`; OpenCode 1.19.x uses a local plugin to add context before model requests.
58
+ Codex requires hooks enabled and host approval of the installed hook; setup preserves those trust and administrator controls.
59
+ Ambient context contains current tool names, status and read/write posture, with explicit authentication or connectivity failure disclosure and no identity or session metadata.
60
+ Skills teach managed command discovery and grant no permissions.
53
61
  Artium's authenticated setup fetches granted tools' adapted skills; a standalone skill installer does not configure this server account.
54
62
  Start with the [compact investigation guide](skill/artium-axi/SKILL.md#investigation-quick-guide) in the base skill.
55
63
  See the [command reference](docs/commands.md) and authenticated `artium-axi tools show <tool>` for commands.
56
64
  Re-run setup after moving the executable or changing grants.
57
- To remove the hook, delete only objects labelled `statusMessage: "artium-axi managed tools"` from `hooks.SessionStart` in the Claude host's `settings.json`.
58
- See [installation paths and manual skill removal](docs/client-reference.md#agent-installation).
65
+ See [installation paths, host requirements and manual removal](docs/client-reference.md#agent-installation) and [supported integration boundaries](docs/safety.md#agent-session-context).
66
+ Ordinary discovery and tool calls never install or repair agent settings.
59
67
 
60
68
  <a id="features"></a>
61
69
  <a id="commands"></a>
@@ -74,9 +82,9 @@ Write capabilities below require administrator opt-in.
74
82
  | Azure | Subscriptions, resources and queries | Reads; reviewed writes | [Credentials](docs/tool-credentials.md#azure) |
75
83
  | Microsoft Graph | Entra, optional mail and hunting packs | Reads; selected writes | [Capabilities](docs/safety.md#microsoft-graph) |
76
84
  | LDAP | Directory investigation over verified TLS | Read-only | [Credentials](docs/tool-credentials.md#ldap) |
77
- | Azure DevOps | Organization and project workflows | Reads; reviewed writes | [Credentials](docs/tool-credentials.md#azure-devops) |
85
+ | Azure DevOps | Organization and project workflows | Reads; gated work-item, PR, pipeline, repository, policy and ref writes; API writes on server-listed paths (TD-067) | [Credentials](docs/tool-credentials.md#azure-devops) |
78
86
  | GitHub | Repository investigation and collaboration | Reads; selected writes | [Credentials](docs/tool-credentials.md#github) |
79
- | AWX | Jobs, workflows and operational actions | Reads; selected writes | [Credentials](docs/tool-credentials.md#awx) |
87
+ | AWX | Jobs, workflows, operational actions and ordinary resource configuration | Reads; separate operational and configuration write controls | [Credentials](docs/tool-credentials.md#awx) |
80
88
  | Tenable One | Exposure investigation and export jobs | Reads; selected writes | [Credentials](docs/tool-credentials.md#tenable-one) |
81
89
  | Hybrid Analysis | Sandbox investigations, YARA and archives | Reads; selected writes/saves | [Credentials](docs/tool-credentials.md#hybrid-analysis) |
82
90
  | Check Point Email Security | Email investigation and response | Reads; selected writes/saves | [Credentials](docs/tool-credentials.md#check-point-email-security) |
@@ -114,6 +122,8 @@ Connection settings are saved in `config.json` beside `session.json`; tool profi
114
122
  | `XDG_CONFIG_HOME` | Linux/macOS config base | `~/.config` |
115
123
  | `APPDATA` | Windows config base | Required on Windows |
116
124
  | `CLAUDE_CONFIG_DIR` | Claude setup directory | `~/.claude` |
125
+ | `CODEX_HOME` | Codex hook configuration directory; skills use `~/.agents` | `~/.codex` |
126
+ | `OPENCODE_CONFIG_DIR` | OpenCode setup directory | `${XDG_CONFIG_HOME:-~/.config}/opencode` |
117
127
  | `PI_CODING_AGENT_DIR` | Pi setup directory | `~/.pi/agent` |
118
128
  | `ARTIUM_AXI_TEST_HTTP` | Test-only loopback HTTP when `1` | Disabled |
119
129
  | `ARTIUM_AXI_SESSION_ACL_PATH`, `ARTIUM_AXI_SESSION_ACL_KIND` | Internal Windows ACL subprocess inputs | Set by client; do not configure |
@@ -137,6 +147,7 @@ Tool output limits vary; `--full` restores supported text within byte/time budge
137
147
  | 2 | Usage or configuration error |
138
148
 
139
149
  See [output behavior](docs/client-reference.md#toon-output-behavior) and the generated [error catalogue](docs/errors.md).
150
+ The [`session-context` command](docs/commands.md) also exits 0 when it emits an unavailable diagnostic for an agent host.
140
151
 
141
152
  ## Troubleshooting
142
153