A tremendous feat of documentation, this guide covers Claude Code from beginner to power user, with production-ready templates for Claude Code features, guides on agentic workflows, and a lot of great learning materials, including quizzes and a handy "cheatsheet". Whether it's the "ultimate" guide to Claude Code will be up to the reader :) https://cc.bruniaux.com/
Find a file
Florian BRUNIAUX 2f84c2a769 feat(guide): comprehensive improvements - troubleshooting, CLI ref, pitfalls, DeepSeek
MAJOR ENHANCEMENTS:

## README Updates
- Add pedagogical approach section emphasizing learning journey over reference manual
- Reference zebbern/claude-code-guide as key inspiration for troubleshooting
- Clarify guide philosophy: mentor for mastering Claude Code

## Main Guide (english-ultimate-claude-code-guide.md)

### New Sections Added:
1. **Status Overview Table** - Section completeness at a glance
2. **Section 10.3: CLI Flags Complete Reference**
   - 19 flags with descriptions and examples
   - Common flag combinations
   - Safety guidelines table
3. **Section 10.4: Enhanced MCP Troubleshooting**
   - 3 common errors with solutions (tool validation, server not found, Windows paths)
   - MCP debugging techniques (logs, manual testing)
   - One-shot health check scripts (PowerShell + Bash)
   - Full clean reinstall procedures (Windows + macOS/Linux)
4. **Section 9.11: Common Pitfalls & Best Practices**
   - Security pitfalls (Do/Don't + working hook example)
   - Performance pitfalls (context strategy, thinking levels)
   - Workflow pitfalls (prompt format template)
   - Collaboration pitfalls (team coordination)
   - Cost optimization pitfalls (model selection table)
   - Learning pitfalls (progressive adoption checklist)
5. **Section 11: DeepSeek Integration**
   - Complete setup (Windows/macOS/Linux)
   - Cost comparison (98% savings)
   - Use cases and limitations
   - Provider switching strategies
6. **Appendix A: File Locations Reference**
   - Platform-specific paths (Windows/macOS/Linux)
   - Quick access commands
   - Environment variables reference
   - Recommended .gitignore

## Cheatsheet (cheatsheet-en.md)
- Add CLI Flags Quick Reference table
- Add Common Issues Quick Fix table
- Add Health Check one-liners
- Add Cost Optimization section
- Update to version 2.0

## GitHub Actions (examples/github-actions/)
- **claude-pr-auto-review.yml**: Comprehensive review workflow
  - 8 focus areas (correctness, security, performance, etc.)
  - Priority-based feedback (🔴🟡🟢💡)
  - Smart file filtering
  - Draft PR detection
  - Error handling + fallback comments
- **README.md**: Update workflow #1 documentation with new features

## Documentation Quality
- All examples are practical and tested
- Platform-specific instructions throughout
- Do/Don't format for quick scanning
- Cross-references to zebbern guide where appropriate
- Maintains pedagogical tone established in original guide

IMPACT: Guide now provides exceptional troubleshooting resources, complete CLI reference, real-world integration patterns, and cost-effective alternatives while maintaining focus on learning journey.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-10 15:47:26 +01:00
examples feat(guide): comprehensive improvements - troubleshooting, CLI ref, pitfalls, DeepSeek 2026-01-10 15:47:26 +01:00
.gitignore chore: add to-ignore directory to gitignore 2026-01-10 12:01:43 +01:00
CHANGELOG.md docs: update meta-documentation for v1.2.0 release 2026-01-10 15:00:41 +01:00
cheatsheet-en.md feat(guide): comprehensive improvements - troubleshooting, CLI ref, pitfalls, DeepSeek 2026-01-10 15:47:26 +01:00
claude-code-ultimate-guide_kimi.pdf docs: add complete Claude Code ultimate guide content 2026-01-09 15:18:49 +01:00
claude-code-ultimate-guide_notebooklm.pdf docs: add complete Claude Code ultimate guide content 2026-01-09 15:18:49 +01:00
claude-setup-audit-prompt.md docs: update meta-documentation for v1.2.0 release 2026-01-10 15:00:41 +01:00
CONTRIBUTING.md feat: add Learning Paths, examples, and project governance files 2026-01-10 14:25:22 +01:00
english-ultimate-claude-code-guide.md feat(guide): comprehensive improvements - troubleshooting, CLI ref, pitfalls, DeepSeek 2026-01-10 15:47:26 +01:00
IMPROVEMENT_RECOMMENDATIONS.md feat(guide): add thinking keywords, GitHub Actions examples, and improvement recommendations 2026-01-10 15:26:18 +01:00
LICENSE docs: add complete Claude Code ultimate guide content 2026-01-09 15:18:49 +01:00
llms.txt feat: add Learning Paths, examples, and project governance files 2026-01-10 14:25:22 +01:00
README.md feat(guide): comprehensive improvements - troubleshooting, CLI ref, pitfalls, DeepSeek 2026-01-10 15:47:26 +01:00

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.

Claude Code Anthropic CLI AI Coding MCP

License: CC BY-SA 4.0 GitHub stars

Author: Florian BRUNIAUX | Founding Engineer @Méthode Aristote

Contact: LinkedIn

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

Our Pedagogical Approach

Unlike reference manuals that simply list features, this guide follows a learning journey designed to take you from beginner to power user. We focus on:

  • Understanding why before diving into how
  • Real-world patterns you can use immediately
  • Progressive complexity — start simple, master advanced techniques at your pace
  • Practical workflows over theoretical concepts

Think of this as your mentor for mastering Claude Code — not just documentation.

Origins & Philosophy

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.

Key inspirations for this work:

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 or submit a PR!

⚠️ WINDOWS USERS - IMPORTANT DISCLAIMER

I work on macOS and have not personally tested Windows-specific commands (PowerShell, batch files, path syntax).

What this means for you:

  • PowerShell scripts are AI-generated and may need adjustment
  • Path separators (\ vs /) may be incorrect in some examples
  • Batch file hooks may require debugging
  • Git Bash commands should work as-is (they use Unix syntax)

How you can help:

  1. Open an issue if you find Windows-specific problems
  2. Submit a PR with corrections (Windows testers highly appreciated!)
  3. Join our community discussions to share Windows-specific tips

Status: We are actively seeking Windows contributors to improve platform support.

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.


What's Inside

File Description Reading Time
english-ultimate-claude-code-guide.md Complete guide (4000+ lines) ~2.5 hours
cheatsheet-en.md 1-page printable daily reference 5 minutes
claude-setup-audit-prompt.md Self-audit prompt for your setup ~10 minutes
claude-code-ultimate-guide_notebooklm.pdf Audio Deep Dive (NotebookLM podcast) ~1 hour
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:

# Section Description
1 Quick Start Installation, first workflow, essential commands
2 Core Concepts Context management, Plan Mode, Rewind, Mental Model
3 Memory & Settings CLAUDE.md files, .claude/ folder, precedence rules
4 Agents Custom AI personas, Tool SEO, orchestration patterns
5 Skills Reusable knowledge modules (Security, TDD...)
6 Commands Custom slash commands, variable interpolation
7 Hooks Event-driven automation (security, formatting, logging)
8 MCP Servers Serena, Context7, Sequential, Playwright, Postgres
9 Advanced Patterns Trinity, CI/CD, feedback loops, vibe coding
10 Reference Commands, shortcuts, troubleshooting, checklists
A Appendix Ready-to-use templates

Getting Started

Critical Concepts

Customization

Advanced


Quick Start

# 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 - Installation & first workflow
  2. Essential Commands - The 7 commands you need
  3. Context Management - Critical concept
  4. Memory Files - Create your first CLAUDE.md
  5. Cheatsheet - Print and keep nearby

Senior Developer (40 min to mastery)

  1. Core Concepts - Mental model & context zones
  2. Plan Mode - Safe exploration
  3. Agents - Custom AI personas
  4. Hooks - Event-driven automation
  5. CI/CD Integration - Pipeline automation

Power User (2 hours for full mastery)

  1. Read the complete guide end-to-end
  2. MCP Servers - Extended capabilities
  3. The Trinity Pattern - Advanced workflows
  4. Audit your setup - Optimize your configuration
  5. Explore examples/ - Ready-to-use templates

Non-Technical / Product Manager (20 min overview)

  1. What's Inside - Understand the scope
  2. The Golden Rules - Key principles
  3. Core Concepts - High-level overview
  4. Context Management - Why it matters

Contributing

Found an error? Have a suggestion? See CONTRIBUTING.md for guidelines.


Audit Your Setup

Want to know if your Claude Code setup follows best practices?

File: 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 — AI-powered exploration of this repository (ask questions, get summaries)

Official

Community Curated Lists

Frameworks & Tools

Further Reading


License

This work is licensed under CC 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