sbx: document overriding agent settings from a kit#25160
Open
dvdksn wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟡 NEEDS ATTENTION
Two medium-severity issues found in the new content — both on the same closing sentence of the new kit-examples.md section. The overall approach (using commands.startup with a heredoc) is sound and the docs are clear. No redirects needed (new content only).
Sandboxes write settings files for some built-in agents (such as /home/agent/.claude/settings.json for the claude agent) via a PostStart hook in vm_configurator.go, which fires after kit static files and initFiles. Document the overwrite behavior in kits.md and add a worked commands.startup example in kit-examples.md.
bd0abfd to
1bdda1a
Compare
mdelapenya
approved these changes
May 26, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Static files and
initFilescan't override paths the active agent writes during its own setup (such as/home/agent/.claude/settings.json), because the agent's setup runs after kit injection. This surfaced from user feedback on the kits page.kits.md(Inject files): short conceptual note that workspace files work as static files, but user-scope paths under/home/agent/get overwritten, with a pointer to the example.kit-examples.md: new "Override agent settings" section with acommands.startupworkaround using a heredoc.Generated by Claude Code