docs: add complete Claude Code ultimate guide content
- Add comprehensive guide (4000+ lines) covering all Claude Code features - Add printable cheatsheet for daily reference - Add PDF versions (NotebookLM podcast, Kimi export) - Update README with author context, inspiration sources, and contact info - Change license from MIT to CC BY-SA 4.0 for content sharing Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
b0cafce1f7
commit
afd9cb6f20
6 changed files with 5260 additions and 17 deletions
440
LICENSE
440
LICENSE
|
|
@ -1,21 +1,427 @@
|
|||
MIT License
|
||||
Attribution-ShareAlike 4.0 International
|
||||
|
||||
Copyright (c) 2026 Florian BRUNIAUX
|
||||
=======================================================================
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||
does not provide legal services or legal advice. Distribution of
|
||||
Creative Commons public licenses does not create a lawyer-client or
|
||||
other relationship. Creative Commons makes its licenses and related
|
||||
information available on an "as-is" basis. Creative Commons gives no
|
||||
warranties regarding its licenses, any material licensed under their
|
||||
terms and conditions, or any related information. Creative Commons
|
||||
disclaims all liability for damages resulting from their use to the
|
||||
fullest extent possible.
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
Using Creative Commons Public Licenses
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
Creative Commons public licenses provide a standard set of terms and
|
||||
conditions that creators and other rights holders may use to share
|
||||
original works of authorship and other material subject to copyright
|
||||
and certain other rights specified in the public license below. The
|
||||
following considerations are for informational purposes only, are not
|
||||
exhaustive, and do not form part of our licenses.
|
||||
|
||||
Considerations for licensors: Our public licenses are
|
||||
intended for use by those authorized to give the public
|
||||
permission to use material in ways otherwise restricted by
|
||||
copyright and certain other rights. Our licenses are
|
||||
irrevocable. Licensors should read and understand the terms
|
||||
and conditions of the license they choose before applying it.
|
||||
Licensors should also secure all rights necessary before
|
||||
applying our licenses so that the public can reuse the
|
||||
material as expected. Licensors should clearly mark any
|
||||
material not subject to the license. This includes other CC-
|
||||
licensed material, or material used under an exception or
|
||||
limitation to copyright. More considerations for licensors:
|
||||
wiki.creativecommons.org/Considerations_for_licensors
|
||||
|
||||
Considerations for the public: By using one of our public
|
||||
licenses, a licensor grants the public permission to use the
|
||||
licensed material under specified terms and conditions. If
|
||||
the licensor's permission is not necessary for any reason--for
|
||||
example, because of any applicable exception or limitation to
|
||||
copyright--then that use is not regulated by the license. Our
|
||||
licenses grant only permissions under copyright and certain
|
||||
other rights that a licensor has authority to grant. Use of
|
||||
the licensed material may still be restricted for other
|
||||
reasons, including because others have copyright or other
|
||||
rights in the material. A licensor may make special requests,
|
||||
such as asking that all changes be marked or described.
|
||||
Although not required by our licenses, you are encouraged to
|
||||
respect those requests where reasonable. More_considerations
|
||||
for the public:
|
||||
wiki.creativecommons.org/Considerations_for_licensees
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons Attribution-ShareAlike 4.0 International Public
|
||||
License
|
||||
|
||||
By exercising the Licensed Rights (defined below), You accept and agree
|
||||
to be bound by the terms and conditions of this Creative Commons
|
||||
Attribution-ShareAlike 4.0 International Public License ("Public
|
||||
License"). To the extent this Public License may be interpreted as a
|
||||
contract, You are granted the Licensed Rights in consideration of Your
|
||||
acceptance of these terms and conditions, and the Licensor grants You
|
||||
such rights in consideration of benefits the Licensor receives from
|
||||
making the Licensed Material available under these terms and
|
||||
conditions.
|
||||
|
||||
|
||||
Section 1 -- Definitions.
|
||||
|
||||
a. Adapted Material means material subject to Copyright and Similar
|
||||
Rights that is derived from or based upon the Licensed Material
|
||||
and in which the Licensed Material is translated, altered,
|
||||
arranged, transformed, or otherwise modified in a manner requiring
|
||||
permission under the Copyright and Similar Rights held by the
|
||||
Licensor. For purposes of this Public License, where the Licensed
|
||||
Material is a musical work, performance, or sound recording,
|
||||
Adapted Material is always produced where the Licensed Material is
|
||||
synched in timed relation with a moving image.
|
||||
|
||||
b. Adapter's License means the license You apply to Your Copyright
|
||||
and Similar Rights in Your contributions to Adapted Material in
|
||||
accordance with the terms and conditions of this Public License.
|
||||
|
||||
c. BY-SA Compatible License means a license listed at
|
||||
creativecommons.org/compatiblelicenses, approved by Creative
|
||||
Commons as essentially the equivalent of this Public License.
|
||||
|
||||
d. Copyright and Similar Rights means copyright and/or similar rights
|
||||
closely related to copyright including, without limitation,
|
||||
performance, broadcast, sound recording, and Sui Generis Database
|
||||
Rights, without regard to how the rights are labeled or
|
||||
categorized. For purposes of this Public License, the rights
|
||||
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||
Rights.
|
||||
|
||||
e. Effective Technological Measures means those measures that, in the
|
||||
absence of proper authority, may not be circumvented under laws
|
||||
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||
Treaty adopted on December 20, 1996, and/or similar international
|
||||
agreements.
|
||||
|
||||
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||
any other exception or limitation to Copyright and Similar Rights
|
||||
that applies to Your use of the Licensed Material.
|
||||
|
||||
g. License Elements means the license attributes listed in the name
|
||||
of a Creative Commons Public License. The License Elements of this
|
||||
Public License are Attribution and ShareAlike.
|
||||
|
||||
h. Licensed Material means the artistic or literary work, database,
|
||||
or other material to which the Licensor applied this Public
|
||||
License.
|
||||
|
||||
i. Licensed Rights means the rights granted to You subject to the
|
||||
terms and conditions of this Public License, which are limited to
|
||||
all Copyright and Similar Rights that apply to Your use of the
|
||||
Licensed Material and that the Licensor has authority to license.
|
||||
|
||||
j. Licensor means the individual(s) or entity(ies) granting rights
|
||||
under this Public License.
|
||||
|
||||
k. Share means to provide material to the public by any means or
|
||||
process that requires permission under the Licensed Rights, such
|
||||
as reproduction, public display, public performance, distribution,
|
||||
dissemination, communication, or importation, and to make material
|
||||
available to the public including in ways that members of the
|
||||
public may access the material from a place and at a time
|
||||
individually chosen by them.
|
||||
|
||||
l. Sui Generis Database Rights means rights other than copyright
|
||||
resulting from Directive 96/9/EC of the European Parliament and of
|
||||
the Council of 11 March 1996 on the legal protection of databases,
|
||||
as amended and/or succeeded, as well as other essentially
|
||||
equivalent rights anywhere in the world.
|
||||
|
||||
m. You means the individual or entity exercising the Licensed Rights
|
||||
under this Public License. Your has a corresponding meaning.
|
||||
|
||||
|
||||
Section 2 -- Scope.
|
||||
|
||||
a. License grant.
|
||||
|
||||
1. Subject to the terms and conditions of this Public License,
|
||||
the Licensor hereby grants You a worldwide, royalty-free,
|
||||
non-sublicensable, non-exclusive, irrevocable license to
|
||||
exercise the Licensed Rights in the Licensed Material to:
|
||||
|
||||
a. reproduce and Share the Licensed Material, in whole or
|
||||
in part; and
|
||||
|
||||
b. produce, reproduce, and Share Adapted Material.
|
||||
|
||||
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||
Exceptions and Limitations apply to Your use, this Public
|
||||
License does not apply, and You do not need to comply with
|
||||
its terms and conditions.
|
||||
|
||||
3. Term. The term of this Public License is specified in Section
|
||||
6(a).
|
||||
|
||||
4. Media and formats; technical modifications allowed. The
|
||||
Licensor authorizes You to exercise the Licensed Rights in
|
||||
all media and formats whether now known or hereafter created,
|
||||
and to make technical modifications necessary to do so. The
|
||||
Licensor waives and/or agrees not to assert any right or
|
||||
authority to forbid You from making technical modifications
|
||||
necessary to exercise the Licensed Rights, including
|
||||
technical modifications necessary to circumvent Effective
|
||||
Technological Measures. For purposes of this Public License,
|
||||
simply making modifications authorized by this Section 2(a)
|
||||
(4) never produces Adapted Material.
|
||||
|
||||
5. Downstream recipients.
|
||||
|
||||
a. Offer from the Licensor -- Licensed Material. Every
|
||||
recipient of the Licensed Material automatically
|
||||
receives an offer from the Licensor to exercise the
|
||||
Licensed Rights under the terms and conditions of this
|
||||
Public License.
|
||||
|
||||
b. Additional offer from the Licensor -- Adapted Material.
|
||||
Every recipient of Adapted Material from You
|
||||
automatically receives an offer from the Licensor to
|
||||
exercise the Licensed Rights in the Adapted Material
|
||||
under the conditions of the Adapter's License You apply.
|
||||
|
||||
c. No downstream restrictions. You may not offer or impose
|
||||
any additional or different terms or conditions on, or
|
||||
apply any Effective Technological Measures to, the
|
||||
Licensed Material if doing so restricts exercise of the
|
||||
Licensed Rights by any recipient of the Licensed
|
||||
Material.
|
||||
|
||||
6. No endorsement. Nothing in this Public License constitutes or
|
||||
may be construed as permission to assert or imply that You
|
||||
are, or that Your use of the Licensed Material is, connected
|
||||
with, or sponsored, endorsed, or granted official status by,
|
||||
the Licensor or others designated to receive attribution as
|
||||
provided in Section 3(a)(1)(A)(i).
|
||||
|
||||
b. Other rights.
|
||||
|
||||
1. Moral rights, such as the right of integrity, are not
|
||||
licensed under this Public License, nor are publicity,
|
||||
privacy, and/or other similar personality rights; however, to
|
||||
the extent possible, the Licensor waives and/or agrees not to
|
||||
assert any such rights held by the Licensor to the limited
|
||||
extent necessary to allow You to exercise the Licensed
|
||||
Rights, but not otherwise.
|
||||
|
||||
2. Patent and trademark rights are not licensed under this
|
||||
Public License.
|
||||
|
||||
3. To the extent possible, the Licensor waives any right to
|
||||
collect royalties from You for the exercise of the Licensed
|
||||
Rights, whether directly or through a collecting society
|
||||
under any voluntary or waivable statutory or compulsory
|
||||
licensing scheme. In all other cases the Licensor expressly
|
||||
reserves any right to collect such royalties.
|
||||
|
||||
|
||||
Section 3 -- License Conditions.
|
||||
|
||||
Your exercise of the Licensed Rights is expressly made subject to the
|
||||
following conditions.
|
||||
|
||||
a. Attribution.
|
||||
|
||||
1. If You Share the Licensed Material (including in modified
|
||||
form), You must:
|
||||
|
||||
a. retain the following if it is supplied by the Licensor
|
||||
with the Licensed Material:
|
||||
|
||||
i. identification of the creator(s) of the Licensed
|
||||
Material and any others designated to receive
|
||||
attribution, in any reasonable manner requested by
|
||||
the Licensor (including by pseudonym if
|
||||
designated);
|
||||
|
||||
ii. a copyright notice;
|
||||
|
||||
iii. a notice that refers to this Public License;
|
||||
|
||||
iv. a notice that refers to the disclaimer of
|
||||
warranties;
|
||||
|
||||
v. a URI or hyperlink to the Licensed Material to the
|
||||
extent reasonably practicable;
|
||||
|
||||
b. indicate if You modified the Licensed Material and
|
||||
retain an indication of any previous modifications; and
|
||||
|
||||
c. indicate the Licensed Material is licensed under this
|
||||
Public License, and include the text of, or the URI or
|
||||
hyperlink to, this Public License.
|
||||
|
||||
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||
reasonable manner based on the medium, means, and context in
|
||||
which You Share the Licensed Material. For example, it may be
|
||||
reasonable to satisfy the conditions by providing a URI or
|
||||
hyperlink to a resource that includes the required
|
||||
information.
|
||||
|
||||
3. If requested by the Licensor, You must remove any of the
|
||||
information required by Section 3(a)(1)(A) to the extent
|
||||
reasonably practicable.
|
||||
|
||||
b. ShareAlike.
|
||||
|
||||
In addition to the conditions in Section 3(a), if You Share
|
||||
Adapted Material You produce, the following conditions also apply.
|
||||
|
||||
1. The Adapter's License You apply must be a Creative Commons
|
||||
license with the same License Elements, this version or
|
||||
later, or a BY-SA Compatible License.
|
||||
|
||||
2. You must include the text of, or the URI or hyperlink to, the
|
||||
Adapter's License You apply. You may satisfy this condition
|
||||
in any reasonable manner based on the medium, means, and
|
||||
context in which You Share Adapted Material.
|
||||
|
||||
3. You may not offer or impose any additional or different terms
|
||||
or conditions on, or apply any Effective Technological
|
||||
Measures to, Adapted Material that restrict exercise of the
|
||||
rights granted under the Adapter's License You apply.
|
||||
|
||||
|
||||
Section 4 -- Sui Generis Database Rights.
|
||||
|
||||
Where the Licensed Rights include Sui Generis Database Rights that
|
||||
apply to Your use of the Licensed Material:
|
||||
|
||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||
to extract, reuse, reproduce, and Share all or a substantial
|
||||
portion of the contents of the database;
|
||||
|
||||
b. if You include all or a substantial portion of the database
|
||||
contents in a database in which You have Sui Generis Database
|
||||
Rights, then the database in which You have Sui Generis Database
|
||||
Rights (but not its individual contents) is Adapted Material,
|
||||
|
||||
including for purposes of Section 3(b); and
|
||||
c. You must comply with the conditions in Section 3(a) if You Share
|
||||
all or a substantial portion of the contents of the database.
|
||||
|
||||
For the avoidance of doubt, this Section 4 supplements and does not
|
||||
replace Your obligations under this Public License where the Licensed
|
||||
Rights include other Copyright and Similar Rights.
|
||||
|
||||
|
||||
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||
|
||||
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||
|
||||
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||
|
||||
c. The disclaimer of warranties and limitation of liability provided
|
||||
above shall be interpreted in a manner that, to the extent
|
||||
possible, most closely approximates an absolute disclaimer and
|
||||
waiver of all liability.
|
||||
|
||||
|
||||
Section 6 -- Term and Termination.
|
||||
|
||||
a. This Public License applies for the term of the Copyright and
|
||||
Similar Rights licensed here. However, if You fail to comply with
|
||||
this Public License, then Your rights under this Public License
|
||||
terminate automatically.
|
||||
|
||||
b. Where Your right to use the Licensed Material has terminated under
|
||||
Section 6(a), it reinstates:
|
||||
|
||||
1. automatically as of the date the violation is cured, provided
|
||||
it is cured within 30 days of Your discovery of the
|
||||
violation; or
|
||||
|
||||
2. upon express reinstatement by the Licensor.
|
||||
|
||||
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||
right the Licensor may have to seek remedies for Your violations
|
||||
of this Public License.
|
||||
|
||||
c. For the avoidance of doubt, the Licensor may also offer the
|
||||
Licensed Material under separate terms or conditions or stop
|
||||
distributing the Licensed Material at any time; however, doing so
|
||||
will not terminate this Public License.
|
||||
|
||||
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||
License.
|
||||
|
||||
|
||||
Section 7 -- Other Terms and Conditions.
|
||||
|
||||
a. The Licensor shall not be bound by any additional or different
|
||||
terms or conditions communicated by You unless expressly agreed.
|
||||
|
||||
b. Any arrangements, understandings, or agreements regarding the
|
||||
Licensed Material not stated herein are separate from and
|
||||
independent of the terms and conditions of this Public License.
|
||||
|
||||
|
||||
Section 8 -- Interpretation.
|
||||
|
||||
a. For the avoidance of doubt, this Public License does not, and
|
||||
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||
conditions on any use of the Licensed Material that could lawfully
|
||||
be made without permission under this Public License.
|
||||
|
||||
b. To the extent possible, if any provision of this Public License is
|
||||
deemed unenforceable, it shall be automatically reformed to the
|
||||
minimum extent necessary to make it enforceable. If the provision
|
||||
cannot be reformed, it shall be severed from this Public License
|
||||
without affecting the enforceability of the remaining terms and
|
||||
conditions.
|
||||
|
||||
c. No term or condition of this Public License will be waived and no
|
||||
failure to comply consented to unless expressly agreed to by the
|
||||
Licensor.
|
||||
|
||||
d. Nothing in this Public License constitutes or may be interpreted
|
||||
as a limitation upon, or waiver of, any privileges and immunities
|
||||
that apply to the Licensor or You, including from the legal
|
||||
processes of any jurisdiction or authority.
|
||||
|
||||
|
||||
=======================================================================
|
||||
|
||||
Creative Commons is not a party to its public
|
||||
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||
its public licenses to material it publishes and in those instances
|
||||
will be considered the “Licensor.” The text of the Creative Commons
|
||||
public licenses is dedicated to the public domain under the CC0 Public
|
||||
Domain Dedication. Except for the limited purpose of indicating that
|
||||
material is shared under a Creative Commons public license or as
|
||||
otherwise permitted by the Creative Commons policies published at
|
||||
creativecommons.org/policies, Creative Commons does not authorize the
|
||||
use of the trademark "Creative Commons" or any other trademark or logo
|
||||
of Creative Commons without its prior written consent including,
|
||||
without limitation, in connection with any unauthorized modifications
|
||||
to any of its public licenses or any other arrangements,
|
||||
understandings, or agreements concerning use of licensed material. For
|
||||
the avoidance of doubt, this paragraph does not form part of the
|
||||
public licenses.
|
||||
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
|
|
|
|||
174
README.md
Normal file
174
README.md
Normal file
|
|
@ -0,0 +1,174 @@
|
|||
# The Ultimate Claude Code Guide
|
||||
|
||||
> From zero to power user — a comprehensive, self-contained guide to mastering Claude Code.
|
||||
|
||||
[](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||
|
||||
**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)
|
||||
|
||||
---
|
||||
|
||||
## About This Guide
|
||||
|
||||
This guide is the result of **several months of daily practice and research** with Claude Code. 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.
|
||||
|
||||
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-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 |
|
||||
|
||||
---
|
||||
|
||||
## Guide Overview
|
||||
|
||||
### 1. Quick Start (Day 1)
|
||||
Installation, first workflow, essential commands, permission modes.
|
||||
|
||||
### 2. Core Concepts
|
||||
- **Context Management** — The most critical concept (zones, recovery, poisoning)
|
||||
- **Plan Mode** — Safe exploration before changes
|
||||
- **Rewind** — Undo mistakes safely
|
||||
- **Mental Model** — How Claude sees your codebase
|
||||
|
||||
### 3. Configuration
|
||||
- `CLAUDE.md` files (global, project, local)
|
||||
- The `.claude/` folder structure
|
||||
- Settings & permissions
|
||||
- Precedence rules
|
||||
|
||||
### 4. Agents
|
||||
Create specialized AI personas for specific tasks:
|
||||
- Code reviewer, debugger, backend architect
|
||||
- Tool SEO for better agent discovery
|
||||
- Multi-agent orchestration patterns
|
||||
|
||||
### 5. Skills
|
||||
Reusable knowledge modules:
|
||||
- Security Guardian (OWASP, secrets management)
|
||||
- TDD (Red-Green-Refactor cycle)
|
||||
- Creating your own skills
|
||||
|
||||
### 6. Commands
|
||||
Custom slash commands:
|
||||
- `/commit`, `/pr`, problem framer
|
||||
- Variable interpolation with `$ARGUMENTS`
|
||||
|
||||
### 7. Hooks
|
||||
Event-driven automation:
|
||||
- Security blockers (pre-tool use)
|
||||
- Auto-formatters (post-tool use)
|
||||
- Context enrichers (prompt submit)
|
||||
- Activity logging
|
||||
|
||||
### 8. MCP Servers
|
||||
External tool integrations:
|
||||
- **Serena** — Semantic code navigation
|
||||
- **Context7** — Library documentation
|
||||
- **Sequential** — Structured reasoning
|
||||
- **Playwright** — Browser automation
|
||||
- **Postgres** — Database queries
|
||||
|
||||
### 9. Advanced Patterns
|
||||
- The Trinity (Plan + Think + Agents)
|
||||
- CI/CD & IDE integration
|
||||
- Tight feedback loops
|
||||
- Todo as instruction mirrors
|
||||
- Vibe coding & skeleton projects
|
||||
- Batch operations
|
||||
|
||||
### 10. Reference
|
||||
Commands table, keyboard shortcuts, troubleshooting, checklists.
|
||||
|
||||
### Appendix
|
||||
Ready-to-use templates for agents, skills, commands, hooks, settings, and prompts.
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Install Claude Code
|
||||
curl -fsSL https://claude.ai/install.sh | sh
|
||||
|
||||
# Start in your project
|
||||
cd your-project
|
||||
claude
|
||||
```
|
||||
|
||||
### 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
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
Found an error? Have a suggestion? Open an issue or PR.
|
||||
|
||||
---
|
||||
|
||||
## Resources
|
||||
|
||||
- [Official Claude Code Documentation](https://docs.anthropic.com/en/docs/claude-code)
|
||||
- [Claudelog.com](https://claudelog.com/) — Advanced tips & patterns (inspiration for some sections)
|
||||
|
||||
---
|
||||
|
||||
## 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*
|
||||
298
cheatsheet-en.md
Normal file
298
cheatsheet-en.md
Normal file
|
|
@ -0,0 +1,298 @@
|
|||
# Claude Code Cheatsheet
|
||||
|
||||
**1 printable page** - Daily essentials
|
||||
|
||||
**Author**: Florian BRUNIAUX | Founding Engineer [@Méthode Aristote](https://methode-aristote.fr)
|
||||
|
||||
**Written with**: Claude (Anthropic)
|
||||
|
||||
---
|
||||
|
||||
## Essential Commands
|
||||
|
||||
| Command | Action |
|
||||
|---------|--------|
|
||||
| `/help` | Contextual help |
|
||||
| `/clear` | Reset conversation |
|
||||
| `/compact` | Free up context |
|
||||
| `/context` | View token usage |
|
||||
| `/status` | Session state |
|
||||
| `/exit` | Quit (or Ctrl+D) |
|
||||
|
||||
---
|
||||
|
||||
## Keyboard Shortcuts
|
||||
|
||||
| Shortcut | Action |
|
||||
|----------|--------|
|
||||
| `Shift+Tab` | Cycle permission modes |
|
||||
| `Esc` × 2 | Rewind (undo) |
|
||||
| `Ctrl+C` | Interrupt |
|
||||
| `Tab` | Autocomplete |
|
||||
| `Shift+Enter` | New line |
|
||||
| `Ctrl+D` | Exit |
|
||||
|
||||
---
|
||||
|
||||
## File References
|
||||
|
||||
```
|
||||
@path/to/file.ts → Reference a file
|
||||
@agent-name → Call an agent
|
||||
!shell-command → Run shell command
|
||||
```
|
||||
|
||||
| IDE | Shortcut |
|
||||
|-----|----------|
|
||||
| VS Code | `Alt+K` |
|
||||
| JetBrains | `Cmd+Option+K` |
|
||||
|
||||
---
|
||||
|
||||
## Permission Modes
|
||||
|
||||
| Mode | Editing | Execution |
|
||||
|------|---------|-----------|
|
||||
| Default | Asks | Asks |
|
||||
| Auto-accept | Auto | Asks |
|
||||
| Plan Mode | ❌ | ❌ |
|
||||
|
||||
**Shift+Tab** to switch modes
|
||||
|
||||
---
|
||||
|
||||
## Configuration (2 levels)
|
||||
|
||||
| Level | Location | Scope | Git |
|
||||
|-------|----------|-------|-----|
|
||||
| **Project** | `.claude/` | Team | ✅ |
|
||||
| **Personal** | `~/.claude/` | You (all projects) | ❌ |
|
||||
|
||||
**Priority**: Project overrides Personal
|
||||
|
||||
| File | Where | Usage |
|
||||
|------|-------|-------|
|
||||
| `CLAUDE.md` | Project root | Team instructions |
|
||||
| `settings.json` | `.claude/` | Team permissions |
|
||||
| `settings.local.json` | `.claude/` | Your overrides |
|
||||
| `CLAUDE.md` | `~/.claude/` | Personal instructions |
|
||||
|
||||
---
|
||||
|
||||
## .claude/ Folder Structure
|
||||
|
||||
```
|
||||
.claude/
|
||||
├── CLAUDE.md # Personal instructions
|
||||
├── settings.json # Hooks (committed)
|
||||
├── settings.local.json # Permissions (not committed)
|
||||
├── agents/ # Custom agents
|
||||
├── commands/ # Slash commands
|
||||
├── hooks/ # Event scripts
|
||||
├── rules/ # Auto-loaded rules
|
||||
└── skills/ # Knowledge modules
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Typical Workflow
|
||||
|
||||
```
|
||||
1. Start session → claude
|
||||
2. Check context → /status
|
||||
3. Plan Mode → Shift+Tab × 2 (for complex tasks)
|
||||
4. Describe task → Clear, specific prompt
|
||||
5. Review changes → Always read the diff!
|
||||
6. Accept/Reject → y/n
|
||||
7. Verify → Run tests
|
||||
8. Commit → When task complete
|
||||
9. /compact → When context >70%
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Context Management (CRITICAL)
|
||||
|
||||
### Statusline
|
||||
|
||||
```
|
||||
Model: Sonnet | Ctx: 89.5k | Cost: $2.11 | Ctx(u): 56.0%
|
||||
```
|
||||
**Watch `Ctx(u):`** → >70% = `/compact`, >85% = `/clear`
|
||||
|
||||
### Actions by Symptom
|
||||
|
||||
| Sign | Action |
|
||||
|------|--------|
|
||||
| Short responses | `/compact` |
|
||||
| Frequent forgetting | `/clear` |
|
||||
| >70% context | `/compact` |
|
||||
| Task complete | `/clear` |
|
||||
|
||||
### Context Recovery Commands
|
||||
|
||||
| Command | Usage |
|
||||
|---------|-------|
|
||||
| `/compact` | Summarize and free context |
|
||||
| `/clear` | Fresh start |
|
||||
| `/resume` | Resume previous session |
|
||||
| `/rewind` | Undo recent changes |
|
||||
|
||||
---
|
||||
|
||||
## Plan Mode & Think Levels
|
||||
|
||||
| Feature | Activation | Usage |
|
||||
|---------|------------|-------|
|
||||
| **Plan Mode** | `Shift+Tab × 2` or `/plan` | Explore without modifying |
|
||||
| **Think** | `--think` flag | Standard analysis (~4K tokens) |
|
||||
| **Think Hard** | `--think-hard` flag | Deep analysis (~10K tokens) |
|
||||
| **Ultrathink** | `--ultrathink` flag | Maximum depth (~32K tokens) |
|
||||
|
||||
**Required for**: features >3 files, architecture, complex debugging
|
||||
|
||||
---
|
||||
|
||||
## MCP Servers
|
||||
|
||||
| Server | Purpose |
|
||||
|--------|---------|
|
||||
| **Serena** | Semantic code navigation |
|
||||
| **Context7** | Library documentation |
|
||||
| **Sequential** | Structured reasoning |
|
||||
| **Playwright** | Browser automation |
|
||||
| **Postgres** | Database queries |
|
||||
|
||||
Check status: `/mcp`
|
||||
|
||||
---
|
||||
|
||||
## Creating Custom Components
|
||||
|
||||
### Agent (`.claude/agents/my-agent.md`)
|
||||
```yaml
|
||||
---
|
||||
name: my-agent
|
||||
description: Use when [trigger]
|
||||
model: sonnet
|
||||
tools: Read, Write, Edit, Bash
|
||||
---
|
||||
# Instructions here
|
||||
```
|
||||
|
||||
### Command (`.claude/commands/my-command.md`)
|
||||
```markdown
|
||||
# Command Name
|
||||
Instructions for what to do...
|
||||
$ARGUMENTS - user provided args
|
||||
```
|
||||
|
||||
### Hook (`.claude/hooks/my-hook.sh`)
|
||||
```bash
|
||||
#!/bin/bash
|
||||
INPUT=$(cat)
|
||||
# Process JSON input
|
||||
exit 0 # 0=continue, 2=block
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Anti-patterns
|
||||
|
||||
| ❌ Don't | ✅ Do |
|
||||
|----------|-------|
|
||||
| Vague prompts | Specify file + line |
|
||||
| Accept without reading | Read every diff |
|
||||
| Ignore warnings | Use `/compact` |
|
||||
| Skip permissions | Never in production |
|
||||
| Giant context loads | Load only what's needed |
|
||||
| Negative constraints only | Provide alternatives |
|
||||
|
||||
---
|
||||
|
||||
## Quick Prompting Formula
|
||||
|
||||
```
|
||||
WHAT: [Concrete deliverable]
|
||||
WHERE: [File paths]
|
||||
HOW: [Constraints, approach]
|
||||
VERIFY: [Success criteria]
|
||||
```
|
||||
|
||||
**Example:**
|
||||
```
|
||||
Add input validation to the login form.
|
||||
WHERE: src/components/LoginForm.tsx
|
||||
HOW: Use Zod schema, show inline errors
|
||||
VERIFY: Empty email shows error, invalid format shows error
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Debug Commands
|
||||
|
||||
```bash
|
||||
claude --version # Version
|
||||
claude doctor # Diagnostic
|
||||
claude --debug # Verbose mode
|
||||
claude --mcp-debug # Debug MCPs
|
||||
/mcp # MCP status
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## CI/CD Mode (Headless)
|
||||
|
||||
```bash
|
||||
# Non-interactive execution
|
||||
claude -p "analyze this file" src/api.ts
|
||||
|
||||
# JSON output
|
||||
claude -p "review" --output-format json
|
||||
|
||||
# Economic model
|
||||
claude -p "lint" --model haiku
|
||||
|
||||
# With auto-accept
|
||||
claude -p "fix typos" --dangerously-skip-permissions
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## The Golden Rules
|
||||
|
||||
1. **Always review diffs** before accepting
|
||||
2. **Use `/compact`** before context gets critical (>70%)
|
||||
3. **Be specific** in requests (WHAT, WHERE, HOW, VERIFY)
|
||||
4. **Plan Mode first** for complex/risky tasks
|
||||
5. **Create CLAUDE.md** for every project
|
||||
6. **Commit frequently** after each completed task
|
||||
|
||||
---
|
||||
|
||||
## Quick Decision Tree
|
||||
|
||||
```
|
||||
Simple task → Just ask Claude
|
||||
Complex task → TodoWrite to plan first
|
||||
Risky change → Plan Mode first
|
||||
Repeating task → Create agent or command
|
||||
Context full → /compact or /clear
|
||||
Need docs → Use Context7 MCP
|
||||
Deep analysis → Use --think or --ultrathink
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Resources
|
||||
|
||||
- **Official docs**: [docs.anthropic.com/claude-code](https://docs.anthropic.com/en/docs/claude-code)
|
||||
- **Inspired by**: [Claudelog.com](https://claudelog.com/) - Advanced tips & patterns
|
||||
- **Full guide**: `english-ultimate-claude-code-guide.md`
|
||||
- **Project config**: `CLAUDE.md` at project root
|
||||
|
||||
---
|
||||
|
||||
**Author**: Florian BRUNIAUX | [@Méthode Aristote](https://methode-aristote.fr) | Written with Claude
|
||||
|
||||
*Last updated: January 2025 | Version 1.0*
|
||||
BIN
claude-code-ultimate-guide_kimi.pdf
Normal file
BIN
claude-code-ultimate-guide_kimi.pdf
Normal file
Binary file not shown.
BIN
claude-code-ultimate-guide_notebooklm.pdf
Normal file
BIN
claude-code-ultimate-guide_notebooklm.pdf
Normal file
Binary file not shown.
4365
english-ultimate-claude-code-guide.md
Normal file
4365
english-ultimate-claude-code-guide.md
Normal file
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue