SpyBara
Go Premium

Documentation 2025-12-08 21:01 UTC to 2025-12-09 18:01 UTC

4 files changed +226 −11. View all changes and history on the product overview
2025
Sat 27 06:02 Tue 23 18:02 Sat 20 00:04 Fri 19 21:01 Thu 18 21:01 Wed 17 15:02 Tue 16 21:01 Mon 15 21:01 Sat 13 06:02 Fri 12 21:01 Thu 11 21:02 Wed 10 09:03 Tue 9 18:01 Mon 8 21:01 Sat 6 18:02 Fri 5 00:04 Thu 4 21:02 Wed 3 00:04 Tue 2 21:01 Mon 1 03:31

memory.md +120 −0

Details

12| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------- |12| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------- |

13| **Enterprise policy** | • macOS: `/Library/Application Support/ClaudeCode/CLAUDE.md`<br />• Linux: `/etc/claude-code/CLAUDE.md`<br />• Windows: `C:\Program Files\ClaudeCode\CLAUDE.md` | Organization-wide instructions managed by IT/DevOps | Company coding standards, security policies, compliance requirements | All users in organization |13| **Enterprise policy** | • macOS: `/Library/Application Support/ClaudeCode/CLAUDE.md`<br />• Linux: `/etc/claude-code/CLAUDE.md`<br />• Windows: `C:\Program Files\ClaudeCode\CLAUDE.md` | Organization-wide instructions managed by IT/DevOps | Company coding standards, security policies, compliance requirements | All users in organization |

14| **Project memory** | `./CLAUDE.md` or `./.claude/CLAUDE.md` | Team-shared instructions for the project | Project architecture, coding standards, common workflows | Team members via source control |14| **Project memory** | `./CLAUDE.md` or `./.claude/CLAUDE.md` | Team-shared instructions for the project | Project architecture, coding standards, common workflows | Team members via source control |

15| **Project rules** | `./.claude/rules/*.md` | Modular, topic-specific project instructions | Language-specific guidelines, testing conventions, API standards | Team members via source control |

15| **User memory** | `~/.claude/CLAUDE.md` | Personal preferences for all projects | Code styling preferences, personal tooling shortcuts | Just you (all projects) |16| **User memory** | `~/.claude/CLAUDE.md` | Personal preferences for all projects | Code styling preferences, personal tooling shortcuts | Just you (all projects) |

16| **Project memory (local)** | `./CLAUDE.local.md` | Personal project-specific preferences | Your sandbox URLs, preferred test data | Just you (current project) |17| **Project memory (local)** | `./CLAUDE.local.md` | Personal project-specific preferences | Your sandbox URLs, preferred test data | Just you (current project) |

17 18 


86 * CLAUDE.md memories can be used for both instructions shared with your team and for your individual preferences.87 * CLAUDE.md memories can be used for both instructions shared with your team and for your individual preferences.

87</Tip>88</Tip>

88 89 

90## Modular rules with `.claude/rules/`

91 

92For larger projects, you can organize instructions into multiple files using the `.claude/rules/` directory. This allows teams to maintain focused, well-organized rule files instead of one large CLAUDE.md.

93 

94### Basic structure

95 

96Place markdown files in your project's `.claude/rules/` directory:

97 

98```

99your-project/

100├── .claude/

101│ ├── CLAUDE.md # Main project instructions

102│ └── rules/

103│ ├── code-style.md # Code style guidelines

104│ ├── testing.md # Testing conventions

105│ └── security.md # Security requirements

106```

107 

108All `.md` files in `.claude/rules/` are automatically loaded as project memory, with the same priority as `.claude/CLAUDE.md`.

109 

110### Path-specific rules

111 

112Rules can be scoped to specific files using YAML frontmatter with the `paths` field. These conditional rules only apply when Claude is working with files matching the specified patterns.

113 

114```markdown theme={null}

115---

116paths: src/api/**/*.ts

117---

118 

119# API Development Rules

120 

121- All API endpoints must include input validation

122- Use the standard error response format

123- Include OpenAPI documentation comments

124```

125 

126Rules without a `paths` field are loaded unconditionally and apply to all files.

127 

128### Glob patterns

129 

130The `paths` field supports standard glob patterns:

131 

132| Pattern | Matches |

133| ---------------------- | ---------------------------------------- |

134| `**/*.ts` | All TypeScript files in any directory |

135| `src/**/*` | All files under `src/` directory |

136| `*.md` | Markdown files in the project root |

137| `src/components/*.tsx` | React components in a specific directory |

138 

139You can use braces to match multiple patterns efficiently:

140 

141```markdown theme={null}

142---

143paths: src/**/*.{ts,tsx}

144---

145 

146# TypeScript/React Rules

147```

148 

149This expands to match both `src/**/*.ts` and `src/**/*.tsx`. You can also combine multiple patterns with commas:

150 

151```markdown theme={null}

152---

153paths: {src,lib}/**/*.ts, tests/**/*.test.ts

154---

155```

156 

157### Subdirectories

158 

159Rules can be organized into subdirectories for better structure:

160 

161```

162.claude/rules/

163├── frontend/

164│ ├── react.md

165│ └── styles.md

166├── backend/

167│ ├── api.md

168│ └── database.md

169└── general.md

170```

171 

172All `.md` files are discovered recursively.

173 

174### Symlinks

175 

176The `.claude/rules/` directory supports symlinks, allowing you to share common rules across multiple projects:

177 

178```bash theme={null}

179# Symlink a shared rules directory

180ln -s ~/shared-claude-rules .claude/rules/shared

181 

182# Symlink individual rule files

183ln -s ~/company-standards/security.md .claude/rules/security.md

184```

185 

186Symlinks are resolved and their contents are loaded normally. Circular symlinks are detected and handled gracefully.

187 

188### User-level rules

189 

190You can create personal rules that apply to all your projects in `~/.claude/rules/`:

191 

192```

193~/.claude/rules/

194├── preferences.md # Your personal coding preferences

195└── workflows.md # Your preferred workflows

196```

197 

198User-level rules are loaded before project rules, giving project rules higher priority.

199 

200<Tip>

201 Best practices for `.claude/rules/`:

202 

203 * **Keep rules focused**: Each file should cover one topic (e.g., `testing.md`, `api-design.md`)

204 * **Use descriptive filenames**: The filename should indicate what the rules cover

205 * **Use conditional rules sparingly**: Only add `paths` frontmatter when rules truly apply to specific file types

206 * **Organize with subdirectories**: Group related rules (e.g., `frontend/`, `backend/`)

207</Tip>

208 

89## Organization-level memory management209## Organization-level memory management

90 210 

91Enterprise organizations can deploy centrally managed CLAUDE.md files that apply to all users.211Enterprise organizations can deploy centrally managed CLAUDE.md files that apply to all users.

overview.md +1 −5

Details

48You'll be prompted to log in on first use. That's it! [Continue with Quickstart (5 minutes) →](/en/quickstart)48You'll be prompted to log in on first use. That's it! [Continue with Quickstart (5 minutes) →](/en/quickstart)

49 49 

50<Tip>50<Tip>

51 See [advanced setup](/en/setup) for installation options or [troubleshooting](/en/troubleshooting) if you hit issues.51 Claude Code automatically keeps itself up to date. See [advanced setup](/en/setup) for installation options, manual updates, or uninstallation instructions. Visit [troubleshooting](/en/troubleshooting) if you hit issues.

52</Tip>52</Tip>

53 53 

54<Note>

55 **New VS Code Extension (Beta)**: Prefer a graphical interface? Our new [VS Code extension](/en/vs-code) provides an easy-to-use native IDE experience without requiring terminal familiarity. Simply install from the marketplace and start coding with Claude directly in your sidebar.

56</Note>

57 

58## What Claude Code does for you54## What Claude Code does for you

59 55 

60* **Build features from descriptions**: Tell Claude what you want to build in plain English. It will make a plan, write the code, and ensure it works.56* **Build features from descriptions**: Tell Claude what you want to build in plain English. It will make a plan, write the code, and ensure it works.

sandboxing.md +15 −1

Details

66> /sandbox66> /sandbox

67```67```

68 68 

69This activates the sandboxed bash tool with default settings, allowing access to your current working directory while blocking access to sensitive system locations.69This opens a menu where you can choose between sandbox modes.

70 

71### Sandbox modes

72 

73Claude Code offers two sandbox modes:

74 

75**Auto-allow mode**: Bash commands will attempt to run inside the sandbox and are automatically allowed without requiring permission. Commands that cannot be sandboxed (such as those needing network access to non-allowed hosts) fall back to the regular permission flow. Explicit ask/deny rules you've configured are always respected.

76 

77**Regular permissions mode**: All bash commands go through the standard permission flow, even when sandboxed. This provides more control but requires more approvals.

78 

79In both modes, the sandbox enforces the same filesystem and network restrictions. The difference is only in whether sandboxed commands are auto-approved or require explicit permission.

80 

81<Info>

82 Auto-allow mode works independently of your permission mode setting. Even if you're not in "accept edits" mode, sandboxed bash commands will run automatically when auto-allow is enabled. This means bash commands that modify files within the sandbox boundaries will execute without prompting, even when file edit tools would normally require approval.

83</Info>

70 84 

71### Configure sandboxing85### Configure sandboxing

72 86 

setup.md +90 −5

Details

23 <Tab title="Native Install (Recommended)">23 <Tab title="Native Install (Recommended)">

24 **Homebrew (macOS, Linux):**24 **Homebrew (macOS, Linux):**

25 25 

26 ```sh theme={null}26 ```sh theme={null} theme={null}

27 brew install --cask claude-code27 brew install --cask claude-code

28 ```28 ```

29 29 

30 **macOS, Linux, WSL:**30 **macOS, Linux, WSL:**

31 31 

32 ```bash theme={null}32 ```bash theme={null} theme={null}

33 curl -fsSL https://claude.ai/install.sh | bash33 curl -fsSL https://claude.ai/install.sh | bash

34 ```34 ```

35 35 

36 **Windows PowerShell:**36 **Windows PowerShell:**

37 37 

38 ```powershell theme={null}38 ```powershell theme={null} theme={null}

39 irm https://claude.ai/install.ps1 | iex39 irm https://claude.ai/install.ps1 | iex

40 ```40 ```

41 41 

42 **Windows CMD:**42 **Windows CMD:**

43 43 

44 ```batch theme={null}44 ```batch theme={null} theme={null}

45 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd45 curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd

46 ```46 ```

47 </Tab>47 </Tab>


49 <Tab title="NPM">49 <Tab title="NPM">

50 If you have [Node.js 18 or newer installed](https://nodejs.org/en/download/):50 If you have [Node.js 18 or newer installed](https://nodejs.org/en/download/):

51 51 

52 ```sh theme={null}52 ```sh theme={null} theme={null}

53 npm install -g @anthropic-ai/claude-code53 npm install -g @anthropic-ai/claude-code

54 ```54 ```

55 </Tab>55 </Tab>


214claude update214claude update

215```215```

216 216 

217## Uninstall Claude Code

218 

219If you need to uninstall Claude Code, follow the instructions for your installation method.

220 

221### Native installation

222 

223Remove the Claude Code binary and symlink:

224 

225**macOS, Linux, WSL:**

226 

227```bash theme={null}

228rm -f ~/.local/bin/claude

229rm -rf ~/.claude-code

230```

231 

232**Windows PowerShell:**

233 

234```powershell theme={null}

235Remove-Item -Path "$env:LOCALAPPDATA\Programs\claude-code" -Recurse -Force

236Remove-Item -Path "$env:LOCALAPPDATA\Microsoft\WindowsApps\claude.exe" -Force

237```

238 

239**Windows CMD:**

240 

241```batch theme={null}

242rmdir /s /q "%LOCALAPPDATA%\Programs\claude-code"

243del "%LOCALAPPDATA%\Microsoft\WindowsApps\claude.exe"

244```

245 

246### Homebrew installation

247 

248```bash theme={null}

249brew uninstall --cask claude-code

250```

251 

252### NPM installation

253 

254```bash theme={null}

255npm uninstall -g @anthropic-ai/claude-code

256```

257 

258### Clean up configuration files (optional)

259 

260<Warning>

261 Removing configuration files will delete all your settings, allowed tools, MCP server configurations, and session history.

262</Warning>

263 

264To remove Claude Code settings and cached data:

265 

266**macOS, Linux, WSL:**

267 

268```bash theme={null}

269# Remove user settings and state

270rm -rf ~/.claude

271rm ~/.claude.json

272 

273# Remove project-specific settings (run from your project directory)

274rm -rf .claude

275rm -f .mcp.json

276```

277 

278**Windows PowerShell:**

279 

280```powershell theme={null}

281# Remove user settings and state

282Remove-Item -Path "$env:USERPROFILE\.claude" -Recurse -Force

283Remove-Item -Path "$env:USERPROFILE\.claude.json" -Force

284 

285# Remove project-specific settings (run from your project directory)

286Remove-Item -Path ".claude" -Recurse -Force

287Remove-Item -Path ".mcp.json" -Force

288```

289 

290**Windows CMD:**

291 

292```batch theme={null}

293REM Remove user settings and state

294rmdir /s /q "%USERPROFILE%\.claude"

295del "%USERPROFILE%\.claude.json"

296 

297REM Remove project-specific settings (run from your project directory)

298rmdir /s /q ".claude"

299del ".mcp.json"

300```

301 

217 302 

218---303---

219 304