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> |
||
|---|---|---|
| examples | ||
| .gitignore | ||
| CHANGELOG.md | ||
| cheatsheet-en.md | ||
| claude-code-ultimate-guide_kimi.pdf | ||
| claude-code-ultimate-guide_notebooklm.pdf | ||
| claude-setup-audit-prompt.md | ||
| CONTRIBUTING.md | ||
| english-ultimate-claude-code-guide.md | ||
| IMPROVEMENT_RECOMMENDATIONS.md | ||
| LICENSE | ||
| llms.txt | ||
| README.md | ||
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.
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:
- Claudelog.com — Excellent tips, patterns & tutorials (highly recommended)
- zebbern/claude-code-guide — Comprehensive reference & troubleshooting guide with cybersecurity focus
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:
- Open an issue if you find Windows-specific problems
- Submit a PR with corrections (Windows testers highly appreciated!)
- 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 |
Quick Links by Topic
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
- Always review diffs before accepting changes
- Use
/compactbefore context gets critical (>70%) - Be specific in requests (WHAT, WHERE, HOW, VERIFY)
- Start with Plan Mode for complex/risky tasks
- 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)
- Quick Start - Installation & first workflow
- Essential Commands - The 7 commands you need
- Context Management - Critical concept
- Memory Files - Create your first CLAUDE.md
- Cheatsheet - Print and keep nearby
Senior Developer (40 min to mastery)
- Core Concepts - Mental model & context zones
- Plan Mode - Safe exploration
- Agents - Custom AI personas
- Hooks - Event-driven automation
- CI/CD Integration - Pipeline automation
Power User (2 hours for full mastery)
- Read the complete guide end-to-end
- MCP Servers - Extended capabilities
- The Trinity Pattern - Advanced workflows
- Audit your setup - Optimize your configuration
- Explore examples/ - Ready-to-use templates
Non-Technical / Product Manager (20 min overview)
- What's Inside - Understand the scope
- The Golden Rules - Key principles
- Core Concepts - High-level overview
- 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:
- Copy the prompt from the file
- Run
claude --ultrathinkin your project - 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
- Claude Code Documentation — Official Anthropic docs
Community Curated Lists
- awesome-claude-code — Commands, workflows, IDE integrations
- awesome-claude-skills — Custom skills collection
- awesome-claude-code-subagents — Full-stack & DevOps subagents
- awesome-claude — General Claude resources (SDKs, tools)
- awesome-claude-prompts — Prompt templates
Frameworks & Tools
- SuperClaude — Advanced configuration framework with 30+ commands
- Claudelog.com — Tips, patterns & tutorials
Further Reading
- Nick Tune: Coding Agent Development Workflows — Advanced autonomous workflow patterns
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