@cabane/companion 0.6.209 → 0.6.210

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.
Files changed (2) hide show
  1. package/README.md +7 -7
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,9 +4,9 @@ The Cabane Companion runs your Cabane agents on a device you choose. It receives
4
4
 
5
5
  It uses **Claude Code**, **Codex** or **OpenCode**. The package includes Claude Code and Codex execution binaries, but setup does not run a vendor CLI installer or sign you in. OpenCode needs its own running server.
6
6
 
7
- Start with [Introduction to the Companion](https://cabane.ai/docs/what-the-companion-does), then [Mac setup](https://cabane.ai/docs/on-a-mac), [Windows setup](https://cabane.ai/docs/on-windows) or [Server and VPS setup](https://cabane.ai/docs/on-a-server). [FAQ and Help](https://cabane.ai/docs/faq) covers sign-in and troubleshooting. This README is the device-side reference: commands, configuration and local state.
7
+ Start with [Introduction to the Companion](https://cabane.ai/docs/introduction-to-the-companion), then [Mac setup](https://cabane.ai/docs/mac-setup), [Windows setup](https://cabane.ai/docs/windows-setup) or [Server and VPS setup](https://cabane.ai/docs/server-and-vps-setup). [FAQ and Help](https://cabane.ai/docs/faq-and-help) covers sign-in and troubleshooting. This README is the device-side reference: commands, configuration and local state.
8
8
 
9
- Pairing supplies a device token, not your Cabane password or a full-account token. The device token is for this device's assignments and liveness; assigned agents receive workspace-bound credentials. The [trust guide](https://cabane.ai/docs/what-the-companion-does) explains the layers, records and access.
9
+ Pairing supplies a device token, not your Cabane password or a full-account token. The device token is for this device's assignments and liveness; assigned agents receive workspace-bound credentials. The [trust guide](https://cabane.ai/docs/introduction-to-the-companion) explains the layers, records and access.
10
10
 
11
11
  ## Install
12
12
 
@@ -24,7 +24,7 @@ npm i -g @cabane/companion && cabane setup CODE
24
24
 
25
25
  `cabane setup CODE` pairs the device to your account and joins it to that workspace. From an interactive terminal, setup starts the Companion in the background, waits for its first check-in and reports the device's state. Without an interactive terminal, setup can stay attached to the running Companion. The same line on a device that is already paired joins it to the workspace and mints nothing.
26
26
 
27
- If no harness is usable, interactive setup asks which one you want to set up. Follow the complete CLI installation and sign-in steps for [Mac setup](https://cabane.ai/docs/on-a-mac#3-sign-in-inside-the-environment), [Windows setup](https://cabane.ai/docs/on-windows#3-sign-in-inside-the-environment) or [Server and VPS setup](https://cabane.ai/docs/on-a-server#3-sign-in-without-a-browser), then check `cabane status`.
27
+ If no harness is usable, interactive setup asks which one you want to set up. Follow the complete CLI installation and sign-in steps for [Mac setup](https://cabane.ai/docs/mac-setup#2-sign-in), [Windows setup](https://cabane.ai/docs/windows-setup#2-sign-in) or [Server and VPS setup](https://cabane.ai/docs/server-and-vps-setup#2-sign-in-without-a-browser), then check `cabane status`.
28
28
 
29
29
  ```
30
30
  ✓ Paired as "maya-mbp" with Acme.
@@ -45,7 +45,7 @@ Setup never installs the service. On macOS or Linux, run `cabane service install
45
45
 
46
46
  If `cabane` isn't found afterwards, open a new terminal, or run the `source` line setup printed.
47
47
 
48
- The [server guide](https://cabane.ai/docs/on-a-server) provides a Dockerfile and Compose example to build locally. Its Dockerfile installs the Companion and all three command-line tools; you sign in inside the container. Follow that guide for pairing and starting the Docker environment.
48
+ The [server guide](https://cabane.ai/docs/server-and-vps-setup) provides a Dockerfile and Compose example to build locally. Its Dockerfile installs the Companion and all three command-line tools; you sign in inside the container. Follow that guide for pairing and starting the Docker environment.
49
49
 
50
50
  ## Commands
51
51
 
@@ -69,7 +69,7 @@ For a direct installation, a reboot or a crash leaves the Companion stopped unti
69
69
 
70
70
  On native Windows, check the background process with `cabane status` and run `cabane start` after a Windows restart. If you installed OpenCode outside Docker, keep its server running separately; the Companion's service does not supervise it.
71
71
 
72
- For the Docker example, keep automatic Companion updates off and rebuild the local image to update the Companion and harness tools. Follow the [server guide's update steps](https://cabane.ai/docs/on-a-server#4-keep-it-running-and-update).
72
+ For the Docker example, keep automatic Companion updates off and rebuild the local image to update the Companion and harness tools. Follow the [server guide's update steps](https://cabane.ai/docs/server-and-vps-setup#keep-the-container-running-and-update).
73
73
 
74
74
  Other supervisors: run `cabane start --foreground` with `CABANE_COMPANION_SUPERVISED=1` set, using the absolute paths `~/.cabane/node/bin/node` and `~/.cabane/current/dist/bin.js`, which don't move on an update.
75
75
 
@@ -79,7 +79,7 @@ For a direct installation, after **Rotate token** in Cabane, apply the replaceme
79
79
  2. In `~/.cabane/config.json`, replace `deviceToken` with the replacement token shown by Cabane.
80
80
  3. Run `cabane start`.
81
81
 
82
- For Docker, follow [Rotate a Docker device's token](https://cabane.ai/docs/on-a-server#rotate-a-docker-devices-token).
82
+ For Docker, follow [Rotate a Docker device's token](https://cabane.ai/docs/server-and-vps-setup#rotate-a-docker-devices-token).
83
83
 
84
84
  ## What's on this device
85
85
 
@@ -138,7 +138,7 @@ These names are a contract: changing one would break your command, so none chang
138
138
 
139
139
  ### Harness permissions
140
140
 
141
- The Companion approves Claude Code's tools through a hook and approves OpenCode permission requests; no turn waits for a tool-approval dialog. For Codex it disables approvals and, when your configuration sets a top-level `sandbox_mode`, passes no sandbox flag; without that setting it uses `danger-full-access`. Choose where agents run using [Agent access](https://cabane.ai/docs/how-much-access-agents-get), and configure the tools through [Harness sandboxes](https://cabane.ai/docs/harness-sandboxes).
141
+ The Companion approves Claude Code's tools through a hook and approves OpenCode permission requests; no turn waits for a tool-approval dialog. For Codex it disables approvals and, when your configuration sets a top-level `sandbox_mode`, passes no sandbox flag; without that setting it uses `danger-full-access`. Choose where agents run using [Agent access](https://cabane.ai/docs/agent-access), and configure the tools through [Harness sandboxes](https://cabane.ai/docs/harness-sandboxes).
142
142
 
143
143
  ## Debugging a turn
144
144
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cabane/companion",
3
- "version": "0.6.209",
3
+ "version": "0.6.210",
4
4
  "type": "module",
5
5
  "description": "The Cabane Companion (headless): connect an agent on your machine to your Cabane workspace as a responder — drive work against your own codebase, files, and MCP servers without putting any of it in Cabane.",
6
6
  "license": "UNLICENSED",