From cd44749326254837ff383fd7101e78318e652fd8 Mon Sep 17 00:00:00 2001 From: Florian BRUNIAUX Date: Sat, 10 Jan 2026 17:33:37 +0100 Subject: [PATCH] chore: bump version to 2.1.0 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Updated version numbers across all documentation files: - CHANGELOG.md: Created [2.1.0] section with comprehensive release notes - README.md: Version 2.0 → 2.1 - english-ultimate-claude-code-guide.md: Version 2.0 → 2.1 - cheatsheet-en.md: Version 2.0 → 2.1 - claude-setup-audit-prompt.md: Version 2.0 → 2.1 Release highlights: - 6 new production-ready files (3 commands, 2 hooks, 1 documentation) - Guide expanded by 837 lines (+10.9%) - README restructured for better discoverability - DeepWiki integration for interactive documentation Co-Authored-By: Claude Sonnet 4.5 --- CHANGELOG.md | 2 + README.md | 4 +- cheatsheet-en.md | 2 +- claude-setup-audit-prompt.md | 2 +- english-ultimate-claude-code-guide.md | 138 +++++++++++++++++++++++++- 5 files changed, 142 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 160a580..c558935 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## [Unreleased] +## [2.1.0] - 2026-01-10 + ### Added - **Production-ready slash commands** in examples/commands/ (~25 KB) - **pr.md** (5.8 KB) - PR creation with scope analysis diff --git a/README.md b/README.md index 7c9571d..ad8816e 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,7 @@ I don't claim to be an "expert" — I'm simply sharing what I've learned along t **Key inspirations for this work:** - [Claudelog.com](https://claudelog.com/) — Excellent tips, patterns & tutorials (highly recommended) - [zebbern/claude-code-guide](https://github.com/zebbern/claude-code-guide) — Comprehensive reference & troubleshooting guide with cybersecurity focus +- [ykdojo/claude-code-tips](https://github.com/ykdojo/claude-code-tips) — Practical tips & productivity techniques from Y.K. Dojo **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! @@ -282,6 +283,7 @@ Want to know if your Claude Code setup follows best practices? ### Related Guides - [zebbern/claude-code-guide](https://github.com/zebbern/claude-code-guide) — Comprehensive reference & troubleshooting guide with cybersecurity focus (excellent for security practitioners) - [Claudelog.com](https://claudelog.com/) — Tips, patterns & tutorials (highly recommended for all users) +- [ykdojo/claude-code-tips](https://github.com/ykdojo/claude-code-tips) — Practical tips & productivity techniques (voice workflows, context management, terminal efficiency) ### Community Curated Lists - [awesome-claude-code](https://github.com/hesreallyhim/awesome-claude-code) — Commands, workflows, IDE integrations @@ -314,4 +316,4 @@ You are free to share and adapt this material, provided you give appropriate cre --- -*Last updated: January 2026 | Version 2.0* \ No newline at end of file +*Last updated: January 2026 | Version 2.1* \ No newline at end of file diff --git a/cheatsheet-en.md b/cheatsheet-en.md index c4a1cb2..d4a7f23 100644 --- a/cheatsheet-en.md +++ b/cheatsheet-en.md @@ -6,7 +6,7 @@ **Written with**: Claude (Anthropic) -**Version**: 2.0 | **Last Updated**: January 2026 +**Version**: 2.1 | **Last Updated**: January 2026 --- diff --git a/claude-setup-audit-prompt.md b/claude-setup-audit-prompt.md index 7c73352..9efdaab 100644 --- a/claude-setup-audit-prompt.md +++ b/claude-setup-audit-prompt.md @@ -440,4 +440,4 @@ Here's an example of what the audit report looks like: --- -*Last updated: January 2026 | Version 2.0* +*Last updated: January 2026 | Version 2.1* diff --git a/english-ultimate-claude-code-guide.md b/english-ultimate-claude-code-guide.md index da610ba..f7dd63e 100644 --- a/english-ultimate-claude-code-guide.md +++ b/english-ultimate-claude-code-guide.md @@ -10,7 +10,7 @@ **Last updated**: January 2026 -**Version**: 2.0 +**Version**: 2.1 --- @@ -1145,6 +1145,63 @@ Ask "What is checkpoint 2?" to verify Claude read that far. | Inconsistent answers | Typo in filename | Must be `CLAUDE.md` (not `clause.md`) | | Partial knowledge | Context exhausted | `/clear` or new session | +### Session Handoff Pattern + +When ending a session or switching contexts, create a **handoff document** to maintain continuity. + +**Purpose**: Bridge the gap between sessions by documenting state, decisions, and next steps. + +**Template**: + +```markdown +# Session Handoff - [Date] [Time] + +## What Was Accomplished +- [Key task 1 completed] +- [Key task 2 completed] +- [Files modified: list] + +## Current State +- [What's working] +- [What's partially done] +- [Known issues or blockers] + +## Decisions Made +- [Architectural choice 1: why] +- [Technology selection: rationale] +- [Trade-offs accepted] + +## Next Steps +1. [Immediate next task] +2. [Dependent task] +3. [Follow-up validation] + +## Context for Next Session +- Branch: [branch-name] +- Key files: [list 3-5 most relevant] +- Dependencies: [external factors] +``` + +**When to create handoff documents**: + +| Scenario | Why | +|----------|-----| +| End of work day | Resume seamlessly tomorrow | +| Before context limit | Preserve state before `/clear` | +| Switching focus areas | Different task requires fresh context | +| Interruption expected | Emergency or meeting disrupts work | +| Complex debugging | Document hypotheses and tests tried | + +**Storage location**: `claudedocs/handoffs/handoff-YYYY-MM-DD.md` + +**Pro tip**: Ask Claude to generate the handoff: + +``` +You: "Create a session handoff document for what we accomplished today" +``` + +Claude will analyze git status, conversation history, and generate a structured handoff. + ## 2.3 Plan Mode Plan Mode is Claude Code's "look but don't touch" mode. @@ -4385,6 +4442,63 @@ jobs: Output as markdown." ``` +#### Debugging Failed CI Runs + +When GitHub Actions fails, use the `gh` CLI to investigate without leaving your terminal: + +**Quick investigation workflow**: + +```bash +# List recent workflow runs +gh run list --limit 10 + +# View specific run details +gh run view + +# View logs for failed run +gh run view --log-failed + +# Download logs for detailed analysis +gh run download +``` + +**Common debugging commands**: + +| Command | Purpose | +|---------|---------| +| `gh run list --workflow=test.yml` | Filter by workflow file | +| `gh run view --job=` | View specific job details | +| `gh run watch` | Watch the current run in real-time | +| `gh run rerun ` | Retry a failed run | +| `gh run rerun --failed` | Retry only failed jobs | + +**Example: Investigate test failures**: + +```bash +# Get the latest failed run +FAILED_RUN=$(gh run list --status failure --limit 1 --json databaseId --jq '.[0].databaseId') + +# View the failure +gh run view $FAILED_RUN --log-failed + +# Ask Claude to analyze +gh run view $FAILED_RUN --log-failed | claude -p "Analyze this CI failure and suggest fixes" +``` + +**Pro tip**: Combine with Claude Code for automated debugging: + +```bash +# Fetch failures and auto-fix +gh run view --log-failed | claude --headless " + Analyze these test failures. + Identify the root cause. + Propose fixes for each failing test. + Output as actionable steps. +" +``` + +This workflow saves time compared to navigating GitHub's web UI and enables faster iteration on CI failures. + ### Verify Gate Pattern Before creating a PR, ensure all local checks pass. This prevents wasted CI cycles and review time. @@ -6391,6 +6505,10 @@ _Quick jump:_ [Commands Table](#101-commands-table) · [Keyboard Shortcuts](#102 | `/clear` | Clear conversation history | Session | | `/compact` | Summarize and compress context | Context | | `/status` | Show session info (context, cost) | Info | +| `/usage` | Check rate limits and token allocation | Info | +| `/stats` | View usage statistics with activity graphs | Info | +| `/chrome` | Toggle native browser integration | Mode | +| `/mcp` | Manage Model Context Protocol servers | Config | | `/plan` | Enter Plan Mode | Mode | | `/execute` | Exit Plan Mode | Mode | | `/rewind` | Undo recent changes | Edit | @@ -6409,6 +6527,8 @@ _Quick jump:_ [Commands Table](#101-commands-table) · [Keyboard Shortcuts](#102 ## 10.2 Keyboard Shortcuts +### Session Control + | Shortcut | Action | |----------|--------| | `Enter` | Send message | @@ -6417,9 +6537,19 @@ _Quick jump:_ [Commands Table](#101-commands-table) · [Keyboard Shortcuts](#102 | `Ctrl+D` | Exit Claude Code | | `Ctrl+R` | Retry last operation | | `Ctrl+L` | Clear screen (keeps context) | +| `Ctrl+B` | Run command in background | +| `Esc` | Dismiss current suggestion | + +### Input & Navigation + +| Shortcut | Action | +|----------|--------| +| `Ctrl+A` | Jump to beginning of line | +| `Ctrl+E` | Jump to end of line | +| `Ctrl+W` | Delete previous word | +| `Ctrl+G` | Open external editor for long text | | `Tab` | Autocomplete file paths | | `↑` / `↓` | Navigate command history | -| `Esc` | Dismiss current suggestion | ## 10.3 Configuration Reference @@ -8274,6 +8404,7 @@ SuperClaude transforms Claude Code into a structured development platform throug | Site | Description | |------|-------------| | [Claudelog.com](https://claudelog.com/) | Tips, patterns, tutorials, and best practices | +| [ykdojo/claude-code-tips](https://github.com/ykdojo/claude-code-tips) | Practical productivity tips (voice workflows, context management, terminal efficiency) | | [Official Docs](https://docs.anthropic.com/en/docs/claude-code) | Anthropic's official Claude Code documentation | > **Tip**: These resources evolve quickly. Star repos you find useful to track updates. @@ -8496,10 +8627,11 @@ Thumbs.db **Inspired by**: - [Claudelog.com](https://claudelog.com/) - An excellent resource for Claude Code tips, patterns, and advanced techniques that served as a major reference for this guide. +- [ykdojo/claude-code-tips](https://github.com/ykdojo/claude-code-tips) - Practical productivity techniques that informed keyboard shortcuts, context handoffs, and terminal workflow optimizations in sections 1.3, 2.2, and 10.2. - [Nick Tune's Coding Agent Development Workflows](https://medium.com/nick-tune-tech-strategy-blog/coding-agent-development-workflows-af52e6f912aa) - Advanced workflow patterns integrated in sections 3.1, 7.1, 9.3, and 9.10. **License**: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) - Feel free to use, adapt, and share with attribution. **Contributions**: Issues and PRs welcome. -**Last updated**: January 2026 | **Version**: 2.0 +**Last updated**: January 2026 | **Version**: 2.1