claude-code-docs  by ericbuess

Local Claude documentation access

Created 2 months ago
375 stars

Top 75.7% on SourcePulse

GitHubView on GitHub
1 Expert Loves This Project
Project Summary

This project provides a local mirror of Claude Code documentation, enabling faster access and offline use. It's designed for developers who frequently interact with Claude Code and want to streamline their workflow by having documentation readily available without web requests. The key benefit is significantly improved access speed and the ability to track documentation changes over time.

How It Works

The tool installs locally, creating a /docs slash command within the Claude Code environment. This command allows users to query documentation directly. An automatic "PreToolUse" hook is configured to perform a git pull before reading documentation, ensuring the local copy stays relatively up-to-date with the official Anthropic documentation. This approach prioritizes speed and local control over always fetching live data.

Quick Start & Requirements

  • Install: Run curl -fsSL https://raw.githubusercontent.com/ericbuess/claude-code-docs/main/install.sh | bash
  • Prerequisites: git, jq, curl, and Claude Code itself. jq may require installation (apt install jq or yum install jq on Linux).
  • Setup Time: Minimal, primarily dependent on download speed.
  • Docs: Official Repository

Highlighted Details

  • Provides a /docs changelog command for quick access to official Claude Code release notes.
  • Includes a -t flag to check documentation sync status with GitHub.
  • Supports natural language queries and searching across all documentation.
  • Automatically attempts to update documentation via GitHub Actions and on usage.

Maintenance & Community

This is a community project. Contributions are welcome, particularly for Windows support. Users are encouraged to report bugs and suggest features via GitHub issues and discussions.

Licensing & Compatibility

  • Documentation Content: Belongs to Anthropic.
  • Mirror Tool: Open source, contributions welcome.
  • Compatibility: Fully supported on macOS (12+) and Linux (Ubuntu, Debian, Fedora, etc.). Windows is not yet supported.

Limitations & Caveats

This is an early beta release, and users may encounter issues such as occasional auto-update failures or broken documentation links. Windows support is currently missing.

Health Check
Last Commit

14 hours ago

Responsiveness

Inactive

Pull Requests (30d)
4
Issues (30d)
7
Star History
123 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.