Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Jibbscript/claude-code-docs

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

314 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Claude Code Documentation Mirror

Last Update

Local mirror of Claude Code documentation files from https://docs.anthropic.com/en/docs/claude-code/, updated every 3 hours.

πŸ†• Version 0.3.1 Released!

Major improvements:

  • Fixed installation location at ~/.claude-code-docs
  • Automatic migration from old installations
  • Script-based architecture - faster and more reliable
  • Auto-updates on every request - always stay in sync
  • Improved /docs what's new - shows changes with links
  • Simplified sync status - no confusing timestamps
  • Better performance - all operations faster

Upgrading: v0.2 users will auto-update. If you installed before July 29, 2025 or don't see a version in /docs -t, run the install command below.

Why This Exists

  • Faster than web fetching - Reads from local files; checks a manifest to know where to look
  • Always up-to-date - Auto-updates every 3 hours via GitHub Actions
  • Track documentation evolution - See exactly what changed in docs over time with git diffs
  • Empower Claude Code - Gives Claude the ability to deeply explore many doc files easily by referencing the manifest

Prerequisites

This tool requires the following to be installed:

  • git - For cloning and updating the repository (usually pre-installed)
  • jq - For JSON processing in the auto-update hook (pre-installed on macOS; Linux users may need apt install jq or yum install jq)
  • curl - For downloading the installation script (usually pre-installed)
  • Claude Code - Obviously :)

Platform Support: macOS and Linux are fully supported. Windows support contributions welcome!

Installation

Run this single command:

curl -fsSL https://raw.githubusercontent.com/ericbuess/claude-code-docs/main/install.sh | bash

This will:

  1. Install to ~/.claude-code-docs (or migrate existing installation)
  2. Create the /docs slash command to pass arguments to the tool and tell it where to find the docs
  3. Set up a 'PreToolUse' 'Read' hook to enable automatic git pull when reading docs from the ~/.claude-code-docs`

Note: The command is /docs (user) - it will show in your command list with "(user)" after it to indicate it's a user-created command.

Usage

The /docs command provides instant access to documentation with optional freshness checking.

Default: Lightning-fast access (no checks)

/docs hooks        # Instantly read hooks documentation
/docs mcp          # Instantly read MCP documentation
/docs memory       # Instantly read memory documentation

You'll see: πŸ“š Reading from local docs (run /docs -t to check freshness)

Check documentation sync status with -t flag

/docs -t           # Show sync status with GitHub
/docs -t hooks     # Check sync status, then read hooks docs
/docs -t mcp       # Check sync status, then read MCP docs

See what's new

/docs what's new   # Show recent documentation changes with diffs

Uninstall

/docs uninstall    # Get commnd to remove claude-code-docs completely

Creative usage examples

# Natural language queries work great
/docs what environment variables exist and how do I use them?
/docs explain the differences between hooks and MCP

# Check for recent changes
/docs -t what's new in the latest documentation?

# Search across all docs
/docs find all mentions of authentication
/docs how do I customize Claude Code's behavior?

How Updates Work

The docs automatically stay up-to-date:

  • GitHub Actions updates the repository every 3 hours
  • The Claude Code PreToolUse hook runs only when a Read is made in the ~/.claude-code-docs directory and checks the GitHub repo for updates
  • If GitHub has newer content, it automatically syncs before reading
  • You'll see "πŸ”„ Updating docs to latest version..." when this happens
  • No manual updates needed!

Performance:

  • Every /docs request automatically checks for updates
  • Updates are pulled automatically when available
  • /docs -t shows sync status without reading a doc

Migration from Older Versions

If you have v0.1 or v0.2 installed, v0.3 will automatically:

  1. Find your existing installation from your current configuration
  2. Migrate to ~/.claude-code-docs
  3. Remove old installation (unless it has uncommitted changes)
  4. Update your command and hook configurations

How to check your version: Run /docs -t and look for "πŸ“¦ Version: X.X"

  • If you see "Version: 0.2" or "Version: 0.3" β†’ You'll auto-update to v0.3.1
  • If you see no version number β†’ You have v0.1, run the install command:
curl -fsSL https://raw.githubusercontent.com/ericbuess/claude-code-docs/main/install.sh | bash

Troubleshooting

Command not found

If /docs returns "command not found":

  1. Check if the command file exists: ls ~/.claude/commands/docs.md
  2. Restart Claude Code to reload commands
  3. Re-run the installation script

Documentation not updating

If documentation seems outdated:

  1. Run /docs -t to check sync status and force an update
  2. Manually update: cd ~/.claude-code-docs && git pull
  3. Check if GitHub Actions are running: View Actions

Installation errors

  • "git/jq/curl not found": Install the missing tool first
  • "Failed to clone repository": Check your internet connection
  • "Failed to update settings.json": Check file permissions on ~/.claude/settings.json

Uninstalling

To completely remove the docs integration:

/docs uninstall

Or run:

~/.claude-code-docs/uninstall.sh

See UNINSTALL.md for manual uninstall instructions.

Security Notes

  • The installer modifies ~/.claude/settings.json to add an auto-update hook
  • The hook only runs git pull when reading documentation files
  • All operations are limited to the documentation directory
  • No data is sent externally - everything is local
  • Repository Trust: The installer clones from GitHub over HTTPS. For additional security, you can:
    • Fork the repository and install from your own fork
    • Clone manually and run the installer from the local directory
    • Review all code before installation

What's New in v0.3.1

  • Security Fix: Enhanced command injection prevention
  • Fixed installation location: Always installs to ~/.claude-code-docs
  • Smart migration: Finds your actual installation from configs (no guessing)
  • Script-based architecture: All logic in a single maintainable script
  • Auto-updates: Every request checks and updates if needed
  • Safe uninstall: Preserves directories with uncommitted changes
  • Natural commands: /docs what's new works with spaces
  • No version dependencies: Simpler, more reliable code

License

Documentation content belongs to Anthropic.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Shell 60.9%
  • Python 39.1%