Skip to content

Environment Variables

OpenShrimp reads the following environment variables at runtime.

Your Anthropic API key. Passed through to the Claude CLI for authentication.

Terminal window
export ANTHROPIC_API_KEY="sk-ant-..."

This is optional if you have authenticated the Claude CLI via OAuth (claude login). When both are available, the API key takes precedence.

These apply only to contexts on the HCS sandbox backend, and only when an artifact is not where the backend looks for it by default.

VariableDescription
OPENSHRIMP_HCS_KERNELKernel the guest boots. Defaults to WSL’s, at C:\Program Files\WSL\tools\kernel
OPENSHRIMP_HCS_INITRDControl initramfs you built yourself, instead of the one downloaded automatically. Unset, a copy staged at C:\ProgramData\openshrimp\hcs\initrd.img is used if present, and the released asset is downloaded otherwise
OPENSHRIMP_HCS_RDP_HELPERDirectory holding an RDP helper bundle you staged yourself, instead of the one downloaded automatically

These are used internally by OpenShrimp and generally don’t need to be set manually.

VariableDescription
OPENSHRIMP_RESTART_CHAT_IDChat ID for post-restart confirmation (set by /restart)
OPENSHRIMP_RESTART_THREAD_IDThread ID for post-restart confirmation (set by /restart)