Skip to content

Document companion state root override#4

Open
BoldNewMedia wants to merge 1 commit into
yanchuk:mainfrom
BoldNewMedia:document-state-root-override
Open

Document companion state root override#4
BoldNewMedia wants to merge 1 commit into
yanchuk:mainfrom
BoldNewMedia:document-state-root-override

Conversation

@BoldNewMedia

Copy link
Copy Markdown

Summary

  • Document the default companion state directory.
  • Document CLAUDE_COMPANION_STATE_ROOT for sandboxed Codex environments where the default state path is not writable.
  • Note that state can include prompts, Claude output, workspace paths, and review results, so it should stay local, private, and out of version control.

Verification

  • node tests/validate-plugin.mjsplugin metadata ok
  • git diff --check → clean

Add README guidance for CLAUDE_COMPANION_STATE_ROOT so sandboxed Codex environments can point companion state at a writable private directory.

Also note that the state root can contain prompts, Claude output, workspace paths, and review results, so it should stay local and out of version control.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant