Repository navigation
docs: add minimal container / agent sandbox instructions to AGENTS.md #2832
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -202,6 +202,37 @@ on Linux, Windows, and macOS. | |
|
|
||
| Do not rerun passing checks on unchanged code merely for additional confidence. | ||
|
|
||
| ## Minimal containers and agent sandboxes | ||
|
|
||
| Fresh dev containers and agent sandboxes (Cursor Cloud, devcontainers, CI | ||
| images) often ship Node but not Bun. Install it first: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://bun.sh/install | bash # installs ~/.bun/bin/bun | ||
| export PATH="$HOME/.bun/bin:$PATH" | ||
| bun install && (cd gui && bun install) | ||
| ``` | ||
|
|
||
| Run the proxy with `bun run src/cli/index.ts start --port <port>`. `/healthz` | ||
| reports status, `/` serves the dashboard, and the management API requires the | ||
| admin token the server writes to `$OPENCODEX_HOME/admin-api-token` at startup. | ||
|
|
||
| `bun run test` has five known environment-only failures in such containers. | ||
| They are not regressions; do not re-investigate them: | ||
|
|
||
| - `service diagnostics > status summary exposes the service log path`, | ||
| `CLI subcommand help > status prints diagnostics without starting the proxy`, | ||
| and `CLI subcommand help > invalid service and codex-shim usage include | ||
| remove alias` require a running systemd init; in a container PID 1 is | ||
| typically `tini` or another minimal init, so service commands report | ||
| "systemd not found". | ||
| - `package tree integrity > an in-place rewrite of the same byte length is | ||
| still a replacement` and `Codex Log Guard inspection > repeat inspection is | ||
| memoized and invalidated by a write` rely on filesystem mtime granularity | ||
| that some container filesystems do not provide. | ||
|
Comment on lines
+229
to
+232
There was a problem hiding this comment.
On filesystems whose modification timestamp does not advance for these writes, the failures demonstrate real runtime behavior rather than harmless test flakiness: AGENTS.md reference: AGENTS.md:L325-L327 Useful? React with 👍 / 👎. |
||
|
|
||
| Everything else passes (15480 pass / 16 skip / 5 fail as of 2.35.0). | ||
|
|
||
| ## Issues and pull requests (agents) | ||
|
|
||
| Agent-created issues and PRs must use the repository templates. The gates | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the fresh-container scenario described here,
OPENCODEX_HOMEis normally unset, whilegetConfigDir()falls back to~/.opencodex. An agent following this text literally will therefore look for/admin-api-tokenafter shell expansion instead of the actual~/.opencodex/admin-api-tokenand will be unable to authenticate direct management API requests. State both the default path and the environment-variable override.Useful? React with 👍 / 👎.