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

jumbojing/claude-code-docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

391 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.2 - Important Update

If you have any previous version installed, please run the installer to update:

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

This update fixes an issue that prevented automatic updates from working properly.

Why This Exists

  • Faster access - Reads from local files instead of fetching from web
  • Automatic updates - Attempts to stay current with the latest documentation
  • Track changes - See what changed in docs over time
  • Better Claude Code integration - Allows Claude to explore documentation more effectively

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 documentation attempts to stay current:

  • GitHub Actions runs periodically to fetch new documentation
  • When you use /docs, it checks for updates
  • Updates are pulled when available
  • You may see "🔄 Updating documentation..." when this happens

Note: If automatic updates fail, you can always run the installer again to get the latest version.

Updating from Previous Versions

Regardless of which version you have installed, simply run:

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

The installer will handle migration and updates automatically.

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.2

  • Fixed automatic update functionality
  • Improved handling of local repository changes
  • Better error recovery during updates

License

Documentation content belongs to Anthropic.

About

基于官方文档

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Shell 61.6%
  • Python 38.4%