readme: Document local aliases and bundled OpenCode plugin

This commit is contained in:
Jeena 2026-09-09 09:42:20 +09:00
parent 6c859eb427
commit 336ec1d97d

View file

@ -29,7 +29,7 @@ Source the helper file `agent.aliases` in your shell configuration (`.bashrc` or
source ~/Projects/agent-container/agent.aliases
```
This makes the `opencode`, `claude`, `pi`, and `agent-container` commands available in new sessions.
This makes the `opencode`, `claude`, `pi`, and `agent-container` commands available in new sessions, plus the `opencode-local`, `claude-local`, and `pi-local` variants that run the tools directly on the host.
The container home directory at `$XDG_DATA_HOME/agent-container/container-home/` serves as a central `$HOME` inside every container, independent of which project directory you start in. Everything written to `$HOME` inside the container persists there.
@ -60,6 +60,9 @@ claude
# Run Pi
pi
# Run a tool directly on the host, bypassing the container
opencode-local
```
The image is built automatically on first use if it does not already exist. The tool starts inside the container with the current directory mounted and set as the working directory.
@ -97,3 +100,17 @@ ln ~/.gitconfig ~/.local/share/agent-container/container-home/.gitconfig
Avoid linking sensitive files such as `~/.ssh/id_*` or `~/.gnupg/` -- keeping those out of the container is an intentional security boundary.
## OpenCode plugins
The repository ships an OpenCode plugin in `plugins/opencode/`:
- `osc99-notify.js`: sends desktop notifications via the OSC 99 escape sequence when OpenCode needs attention (idle, question, permission prompt, error). Notifications only fire while the terminal is unfocused. Tested with Kitty.
To enable it inside the container, copy it into the OpenCode plugin directory of the container home:
```sh
mkdir -p ~/.local/share/agent-container/container-home/.config/opencode/plugins
cp plugins/opencode/osc99-notify.js \
~/.local/share/agent-container/container-home/.config/opencode/plugins/
```