Claude Code Guide

A Claude Code Guide — interactive onboarding and Q&A on setup, best practices, automation, and effective workflows, packaged as a plugin.

New! Enable a proactive learning with Game Mode!
Enable with /guide:game-mode on

Listen to this guide — NotebookLM audio overview provides an AI-generated audio reflection of the guide content.

⭐ Find this useful? Star the repo to follow updates and show support!

Install as a Claude Code Plugin

This repo is a Claude Code plugin. Install it to get interactive guide skills directly inside Claude Code.

Requires Claude Code v1.0.33 or later. Run claude --version to check. See setup docs to install or update.

Quick start (load for current session)

Clone the repo and launch Claude Code with the --plugin-dir flag:

git clone https://github.com/OriNachum/claude-code-guide.git
claude --plugin-dir ./claude-code-guide

This loads the plugin for the current session only. You can also use an absolute path:

claude --plugin-dir /path/to/claude-code-guide

Permanent install (via marketplace)

To install permanently, add this repo as a marketplace from within Claude Code, then install the plugin:

/plugin marketplace add ./claude-code-guide
/plugin install guide@claude-code-guide

Or from the CLI:

claude plugin marketplace add ./claude-code-guide
claude plugin install guide@claude-code-guide

From GitHub (without cloning first)

From within Claude Code:

/plugin marketplace add OriNachum/claude-code-guide
/plugin install guide@claude-code-guide

After installing, restart Claude Code for the plugin skills to become available.

Usage

Once installed, two skills are available:

• /guide:onboard — Interactive getting-started walkthrough. Guides you through environment setup, your first session, and best practices.
• /guide:ask — Ask any question about Claude Code features. Reads relevant reference docs to give accurate, detailed answers.
• /guide:game-mode - Enable Game Mode. The guide will locally track your usage of Claude, assign a level per usage and help you master Claude code.

Documentation

Getting Started

• Setting Your Environment — CLAUDE.md, permissions, model selection, MCP servers, customization
• Starting to Work — Permission modes, Plan Mode, Accept Edits, the explore-plan-implement workflow
• Choosing Your Model — Opus 4.6, Sonnet 4.6, Haiku, effort levels, when to use each
• Best Practices — Self-testing loops, context management, effective prompting, common failure patterns
• Auto Memory — How Claude remembers across sessions, comparison with CLAUDE.md

Automation

• Automating Your Workflows — Overview of the three automation mechanisms: Hooks, Skills, Sub Agents
• Hooks — Lifecycle event automation — triggers, handlers, matchers, common patterns
• Hooks HTTP — HTTP-based hook patterns and integrations
• Skills — Creating reusable prompt workflows as Markdown skill files
• Sub Agents — Specialist agent delegation with scoped permissions, worktree isolation
• Agent Teams — ⚠️ Experimental: coordinated multi-agent sessions with shared task lists

Configuration & Extensions

• Configuring Your Claude — Ongoing configuration — when to build skills, agents, hooks, and how they evolve
• Plugins — Installing, creating, and sharing Claude Code plugins
• Marketplace — Discovering, browsing, evaluating, publishing, and managing plugin marketplaces
• Plugin Examples — Curated showcase of notable plugins with patterns and install instructions
• MCP — MCP (Model Context Protocol) — when to use it, the restaurant analogy, server setup and scopes
• Built-ins — Built-in slash commands, bundled skills, hook events, sub agents, and tools
• Ongoing Work — Managing long-running tasks, resuming work, and session continuity

CI/CD

• GitHub Actions — Running Claude Code in CI/CD pipelines with GitHub Actions

User Stories

Narrative walkthroughs showing Claude Code in real-world scenarios:

• Daily Workflow — A typical day using Claude Code, from morning context to end-of-day
• Getting Started with Claude Code — Your first days on an existing team — /init, building skills organically
• New Project in Existing Repo — Adding a new module/service within an existing codebase
• Auto-Maintain CLAUDE.md — GitHub Actions cron job to keep CLAUDE.md fresh weekly
• Context Management — When to use /clear, /compact, and how to manage context
• Sub Agents in a Monolith — Using sub agents to navigate and work within a large monolith
• Discovering Plugins — Browsing marketplaces, evaluating, and installing your first plugins
• Memory in Practice — How auto memory works — corrections that stick, promoting to CLAUDE.md

Repository structure

claude-code-guide/
├── .claude-plugin/
│   ├── plugin.json              Plugin manifest
│   └── marketplace.json         Marketplace manifest
├── skills/
│   ├── onboard/
│   │   └── SKILL.md             Interactive getting-started walkthrough
│   └── ask/
│       ├── SKILL.md             Q&A against reference docs
│       └── references/
│           ├── stories/         Narrative user-story walkthroughs (7 files)
│           ├── ...              Detailed reference docs (18 files)
├── CLAUDE.md                    Agent instructions
├── PRIVACY.md                   Privacy policy
├── LICENSE                      CC BY 4.0
└── README.md                    This file

Star History

Contributing

Contributions welcome! The skills are at skills/onboard/SKILL.md and skills/ask/SKILL.md. Reference docs are in skills/ask/references/.

License

CC BY 4.0 — see LICENSE for details.

This site is open source. Improve this page.