b2acc9b115
### New Content - Learning Paths section in README (Junior/Senior/Power User/PM tracks) - examples/ folder with 18 ready-to-use templates: - 4 agents (code-reviewer, test-writer, security-auditor, refactoring) - 2 skills (TDD workflow, security checklist) - 3 commands (commit, review-pr, generate-tests) - 4 hooks (bash + PowerShell for security, formatting) - 3 config templates (settings, MCP, gitignore) - 2 memory templates (project + personal CLAUDE.md) ### Governance - CHANGELOG.md: Version history (1.0.0 → 1.1.0 → Unreleased) - CONTRIBUTING.md: Contribution guidelines for community ### Documentation - llms.txt: Updated structure with new files/folders This update makes the guide more actionable with concrete templates and provides clear learning paths for different skill levels. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
246 lines
No EOL
12 KiB
Markdown
246 lines
No EOL
12 KiB
Markdown
# Claude Code Guide: Complete Tutorial & Best Practices
|
|
|
|
> The comprehensive guide to Claude Code — Anthropic's AI coding assistant CLI.
|
|
> From installation to advanced MCP servers, agents, skills, hooks, and CI/CD integration.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[](https://creativecommons.org/licenses/by-sa/4.0/)
|
|
[](https://github.com/FlorianBruniaux/claude-code-ultimate-guide/stargazers)
|
|
|
|
**Author**: [Florian BRUNIAUX](https://github.com/FlorianBruniaux) | Founding Engineer [@Méthode Aristote](https://methode-aristote.fr)
|
|
|
|
**Contact**: [LinkedIn](https://www.linkedin.com/in/florian-bruniaux-43408b83/)
|
|
|
|
**Written with**: Claude (Anthropic)
|
|
|
|
> **If you find this guide useful, please consider giving it a star!** It helps others discover this resource and motivates continued updates.
|
|
|
|
---
|
|
|
|
## About This Guide
|
|
|
|
This guide is the result of **several months of daily practice and research** with Claude Code, Anthropic's AI coding assistant CLI. Whether you're exploring agentic development, LLM-powered coding workflows, or AI pair programming, this resource covers everything from basic setup to advanced MCP server orchestration.
|
|
|
|
I don't claim to be an "expert" — I'm simply sharing what I've learned along the way, humbly hoping to help my peers and evangelize good practices in AI-assisted development.
|
|
|
|
A significant source of inspiration for this work was [Claudelog.com](https://claudelog.com/), which I highly recommend for anyone wanting to go deeper.
|
|
|
|
**Important note**: This guide was largely generated with the help of AI. As such, it likely contains errors, inaccuracies, or outdated information. I would be delighted to receive any feedback, corrections, or — even better — pull requests to improve it. Don't hesitate to [open an issue](../../issues) or submit a PR!
|
|
|
|
**Windows disclaimer**: I work on macOS and have not tested the Windows-specific commands (PowerShell, batch files, paths). Windows instructions were generated with AI assistance. If you encounter issues, please open an issue or PR — contributions from Windows users are especially welcome!
|
|
|
|
**Language**: I wrote this guide in English by default to reach a wider audience, but French is my native language. I could easily translate it to French myself, or leverage AI and community contributions for other languages. Let me know if translations would be useful!
|
|
|
|
If you find value in this guide, have questions, or want to discuss Claude Code practices, feel free to reach out on [LinkedIn](https://www.linkedin.com/in/florian-bruniaux-43408b83/).
|
|
|
|
---
|
|
|
|
## What's Inside
|
|
|
|
| File | Description | Reading Time |
|
|
|------|-------------|--------------|
|
|
| [`english-ultimate-claude-code-guide.md`](./english-ultimate-claude-code-guide.md) | Complete guide (4000+ lines) | ~2.5 hours |
|
|
| [`cheatsheet-en.md`](./cheatsheet-en.md) | 1-page printable daily reference | 5 minutes |
|
|
| [`claude-setup-audit-prompt.md`](./claude-setup-audit-prompt.md) | Self-audit prompt for your setup | ~10 minutes |
|
|
| [`claude-code-ultimate-guide_notebooklm.pdf`](./claude-code-ultimate-guide_notebooklm.pdf) | Audio Deep Dive (NotebookLM podcast) | ~1 hour |
|
|
| [`claude-code-ultimate-guide_kimi.pdf`](./claude-code-ultimate-guide_kimi.pdf) | PDF version (Kimi export) | ~2.5 hours |
|
|
|
|
---
|
|
|
|
## Table of Contents
|
|
|
|
Jump directly to any section in the [full guide](./english-ultimate-claude-code-guide.md):
|
|
|
|
| # | Section | Description |
|
|
|---|---------|-------------|
|
|
| 1 | [Quick Start](./english-ultimate-claude-code-guide.md#1-quick-start-day-1) | Installation, first workflow, essential commands |
|
|
| 2 | [Core Concepts](./english-ultimate-claude-code-guide.md#2-core-concepts) | Context management, Plan Mode, Rewind, Mental Model |
|
|
| 3 | [Memory & Settings](./english-ultimate-claude-code-guide.md#3-memory--settings) | CLAUDE.md files, .claude/ folder, precedence rules |
|
|
| 4 | [Agents](./english-ultimate-claude-code-guide.md#4-agents) | Custom AI personas, Tool SEO, orchestration patterns |
|
|
| 5 | [Skills](./english-ultimate-claude-code-guide.md#5-skills) | Reusable knowledge modules (Security, TDD...) |
|
|
| 6 | [Commands](./english-ultimate-claude-code-guide.md#6-commands) | Custom slash commands, variable interpolation |
|
|
| 7 | [Hooks](./english-ultimate-claude-code-guide.md#7-hooks) | Event-driven automation (security, formatting, logging) |
|
|
| 8 | [MCP Servers](./english-ultimate-claude-code-guide.md#8-mcp-servers) | Serena, Context7, Sequential, Playwright, Postgres |
|
|
| 9 | [Advanced Patterns](./english-ultimate-claude-code-guide.md#9-advanced-patterns) | Trinity, CI/CD, feedback loops, vibe coding |
|
|
| 10 | [Reference](./english-ultimate-claude-code-guide.md#10-reference) | Commands, shortcuts, troubleshooting, checklists |
|
|
| A | [Appendix](./english-ultimate-claude-code-guide.md#appendix-templates-collection) | Ready-to-use templates |
|
|
|
|
### Quick Links by Topic
|
|
|
|
**Getting Started**
|
|
- [Installation](./english-ultimate-claude-code-guide.md#11-installation) · [First Workflow](./english-ultimate-claude-code-guide.md#12-first-workflow) · [Essential Commands](./english-ultimate-claude-code-guide.md#13-essential-commands)
|
|
|
|
**Critical Concepts**
|
|
- [Context Management](./english-ultimate-claude-code-guide.md#22-context-management) · [Plan Mode](./english-ultimate-claude-code-guide.md#23-plan-mode) · [Memory Files](./english-ultimate-claude-code-guide.md#31-memory-files-claudemd)
|
|
|
|
**Customization**
|
|
- [Creating Agents](./english-ultimate-claude-code-guide.md#42-creating-custom-agents) · [Creating Skills](./english-ultimate-claude-code-guide.md#52-creating-skills) · [Creating Commands](./english-ultimate-claude-code-guide.md#62-creating-custom-commands) · [Creating Hooks](./english-ultimate-claude-code-guide.md#72-creating-hooks)
|
|
|
|
**Advanced**
|
|
- [The Trinity Pattern](./english-ultimate-claude-code-guide.md#91-the-trinity) · [CI/CD Integration](./english-ultimate-claude-code-guide.md#93-cicd-integration) · [MCP Configuration](./english-ultimate-claude-code-guide.md#83-configuration)
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Install Claude Code (all platforms)
|
|
npm install -g @anthropic-ai/claude-code
|
|
|
|
# Or on macOS/Linux only:
|
|
curl -fsSL https://claude.ai/install.sh | sh
|
|
|
|
# Start in your project
|
|
cd your-project
|
|
claude
|
|
```
|
|
|
|
> **Windows Users**: Use `%USERPROFILE%\.claude\` instead of `~/.claude/` for all paths in this guide.
|
|
|
|
### The 7 Commands You Need
|
|
|
|
| Command | Action |
|
|
|---------|--------|
|
|
| `/help` | Show all commands |
|
|
| `/status` | Check context usage |
|
|
| `/compact` | Compress context (>70%) |
|
|
| `/clear` | Fresh start |
|
|
| `/plan` | Safe read-only mode |
|
|
| `/rewind` | Undo changes |
|
|
| `Ctrl+C` | Cancel operation |
|
|
|
|
### Context Management (Critical!)
|
|
|
|
| Context % | Action |
|
|
|-----------|--------|
|
|
| 0-50% | Work freely |
|
|
| 50-70% | Be selective |
|
|
| 70-90% | `/compact` now |
|
|
| 90%+ | `/clear` required |
|
|
|
|
---
|
|
|
|
## The Golden Rules
|
|
|
|
1. **Always review diffs** before accepting changes
|
|
2. **Use `/compact`** before context gets critical (>70%)
|
|
3. **Be specific** in requests (WHAT, WHERE, HOW, VERIFY)
|
|
4. **Start with Plan Mode** for complex/risky tasks
|
|
5. **Create CLAUDE.md** for every project
|
|
|
|
---
|
|
|
|
## Who Is This For?
|
|
|
|
- **Beginners**: Start with Quick Start (15 min) → be productive immediately
|
|
- **Intermediate**: Deep dive into Configuration, Agents, Skills
|
|
- **Power Users**: Advanced Patterns, MCP orchestration, CI/CD integration
|
|
|
|
---
|
|
|
|
## Learning Paths
|
|
|
|
Choose your path based on experience and goals:
|
|
|
|
### Junior Developer (45 min to productivity)
|
|
1. [Quick Start](./english-ultimate-claude-code-guide.md#1-quick-start-day-1) - Installation & first workflow
|
|
2. [Essential Commands](./english-ultimate-claude-code-guide.md#13-essential-commands) - The 7 commands you need
|
|
3. [Context Management](./english-ultimate-claude-code-guide.md#22-context-management) - Critical concept
|
|
4. [Memory Files](./english-ultimate-claude-code-guide.md#31-memory-files-claudemd) - Create your first CLAUDE.md
|
|
5. [Cheatsheet](./cheatsheet-en.md) - Print and keep nearby
|
|
|
|
### Senior Developer (40 min to mastery)
|
|
1. [Core Concepts](./english-ultimate-claude-code-guide.md#2-core-concepts) - Mental model & context zones
|
|
2. [Plan Mode](./english-ultimate-claude-code-guide.md#23-plan-mode) - Safe exploration
|
|
3. [Agents](./english-ultimate-claude-code-guide.md#4-agents) - Custom AI personas
|
|
4. [Hooks](./english-ultimate-claude-code-guide.md#7-hooks) - Event-driven automation
|
|
5. [CI/CD Integration](./english-ultimate-claude-code-guide.md#93-cicd-integration) - Pipeline automation
|
|
|
|
### Power User (2 hours for full mastery)
|
|
1. Read the [complete guide](./english-ultimate-claude-code-guide.md) end-to-end
|
|
2. [MCP Servers](./english-ultimate-claude-code-guide.md#8-mcp-servers) - Extended capabilities
|
|
3. [The Trinity Pattern](./english-ultimate-claude-code-guide.md#91-the-trinity) - Advanced workflows
|
|
4. [Audit your setup](./claude-setup-audit-prompt.md) - Optimize your configuration
|
|
5. Explore [examples/](./examples/) - Ready-to-use templates
|
|
|
|
### Non-Technical / Product Manager (20 min overview)
|
|
1. [What's Inside](#whats-inside) - Understand the scope
|
|
2. [The Golden Rules](#the-golden-rules) - Key principles
|
|
3. [Core Concepts](./english-ultimate-claude-code-guide.md#2-core-concepts) - High-level overview
|
|
4. [Context Management](./english-ultimate-claude-code-guide.md#22-context-management) - Why it matters
|
|
|
|
---
|
|
|
|
## Contributing
|
|
|
|
Found an error? Have a suggestion? See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
|
|
|
|
---
|
|
|
|
## Audit Your Setup
|
|
|
|
Want to know if your Claude Code setup follows best practices?
|
|
|
|
**File**: [`claude-setup-audit-prompt.md`](./claude-setup-audit-prompt.md)
|
|
|
|
**How it works**:
|
|
1. Copy the prompt from the file
|
|
2. Run `claude --ultrathink` in your project
|
|
3. Paste the prompt and get a personalized audit report
|
|
|
|
**What it checks**:
|
|
- Memory files (CLAUDE.md) configuration
|
|
- Agents, skills, commands, and hooks setup
|
|
- MCP servers configuration
|
|
- Context management practices
|
|
- CI/CD integration patterns
|
|
|
|
**Output**: A prioritized report with health score, quick wins, and ready-to-use templates tailored to your tech stack.
|
|
|
|
---
|
|
|
|
## Resources
|
|
|
|
### Explore This Guide
|
|
- [DeepWiki](https://deepwiki.com/FlorianBruniaux/claude-code-ultimate-guide) — AI-powered exploration of this repository (ask questions, get summaries)
|
|
|
|
### Official
|
|
- [Claude Code Documentation](https://docs.anthropic.com/en/docs/claude-code) — Official Anthropic docs
|
|
|
|
### Community Curated Lists
|
|
- [awesome-claude-code](https://github.com/hesreallyhim/awesome-claude-code) — Commands, workflows, IDE integrations
|
|
- [awesome-claude-skills](https://github.com/ComposioHQ/awesome-claude-skills) — Custom skills collection
|
|
- [awesome-claude-code-subagents](https://github.com/VoltAgent/awesome-claude-code-subagents) — Full-stack & DevOps subagents
|
|
- [awesome-claude](https://github.com/alvinunreal/awesome-claude) — General Claude resources (SDKs, tools)
|
|
- [awesome-claude-prompts](https://github.com/langgptai/awesome-claude-prompts) — Prompt templates
|
|
|
|
### Frameworks & Tools
|
|
- [SuperClaude](https://github.com/SuperClaude-Org/SuperClaude_Framework) — Advanced configuration framework with 30+ commands
|
|
- [Claudelog.com](https://claudelog.com/) — Tips, patterns & tutorials
|
|
|
|
### Further Reading
|
|
- [Nick Tune: Coding Agent Development Workflows](https://medium.com/nick-tune-tech-strategy-blog/coding-agent-development-workflows-af52e6f912aa) — Advanced autonomous workflow patterns
|
|
|
|
---
|
|
|
|
<!-- SEO Keywords - Do not remove
|
|
claude code, claude code tutorial, claude code guide, anthropic cli,
|
|
ai coding assistant, claude code mcp, claude code agents, claude code hooks,
|
|
claude code skills, claude code installation, claude code commands,
|
|
agentic coding, ai pair programming, llm development tools, ai developer tools,
|
|
anthropic claude, mcp servers, claude code ci/cd, claude code best practices
|
|
-->
|
|
|
|
## License
|
|
|
|
This work is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
|
|
|
|
You are free to share and adapt this material, provided you give appropriate credit and distribute your contributions under the same license.
|
|
|
|
---
|
|
|
|
*Last updated: January 2025 | Version 1.0* |