Skip to content

docs(readme): document filesystem settings defaults and CLAUDE.md loading #1115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TejasAmle wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): document filesystem settings defaults and CLAUDE.md loading #1115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,25 @@ options = ClaudeAgentOptions(
)
```

### Filesystem Settings and CLAUDE.md

By default, the SDK loads filesystem settings the same way the CLI does: the user (`~/.claude`), project (`.claude/` in the working directory), and local (`.claude/settings.local.json`) sources are all read — including `CLAUDE.md` memory files, custom slash commands, and subagents. Your project's `CLAUDE.md` is picked up automatically; no extra configuration is needed.

The flip side is that a deployed agent inherits whatever settings exist on its host machine, so behavior can differ between your laptop and CI, Docker, or Kubernetes. Use `setting_sources` to make this explicit:

```python
# Hermetic (recommended for production/CI): ignore all filesystem settings
options = ClaudeAgentOptions(setting_sources=[])

# Load only project settings and CLAUDE.md — nothing user- or machine-specific
options = ClaudeAgentOptions(
cwd="/path/to/project",
setting_sources=["project"],
)
```

When passing an explicit list, include `"project"` if you want `CLAUDE.md` loaded. See the `setting_sources` docstring in [src/claude_agent_sdk/types.py](src/claude_agent_sdk/types.py) for details.

## ClaudeSDKClient

`ClaudeSDKClient` supports bidirectional, interactive conversations with Claude
Expand Down