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

paulhshort/claude-code-docs

 
 

Repository files navigation

Claude Code Documentation

A community-maintained mirror of Claude Code documentation with automatic updates.

🚀 Quick Start for Users

Option 1: Use Pre-Downloaded Docs (Recommended)

# Clone this repository
git clone https://github.com/ericbuess/claude-code-docs.git
cd claude-code-docs

# The docs/ directory contains all documentation files
ls docs/

Option 2: Fetch Latest from This Repo

# Clone and run the GitHub fetcher
git clone https://github.com/ericbuess/claude-code-docs.git
cd claude-code-docs
python3 fetch_from_github.py

Option 3: Point Claude Code CLI to This Repo

You can reference these docs directly from GitHub using raw URLs:

https://raw.githubusercontent.com/ericbuess/claude-code-docs/main/docs/[filename].md

For example:

  • Overview: https://raw.githubusercontent.com/ericbuess/claude-code-docs/main/docs/overview.md
  • Setup: https://raw.githubusercontent.com/ericbuess/claude-code-docs/main/docs/setup.md

📚 Available Documentation

The docs/ directory contains all 27 Claude Code documentation pages:

  • Getting started guides (overview, setup, quickstart, memory, common-workflows)
  • Build with Claude resources (ide-integrations, mcp, github-actions, sdk, troubleshooting)
  • Deployment options (third-party-integrations, amazon-bedrock, google-vertex-ai, etc.)
  • Administration tools (iam, security, monitoring-usage, costs)
  • Reference documentation (cli-reference, interactive-mode, slash-commands, settings, hooks)
  • Legal and compliance information

🔄 Automatic Updates

This repository automatically updates daily via GitHub Actions. The workflow:

  • Runs every day at 2 AM UTC
  • Fetches the latest documentation from Anthropic
  • Commits any changes automatically
  • Can also be triggered manually from the Actions tab

📖 For Contributors

Fetching Documentation from Source

If you want to update the docs manually:

# Setup
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

# Fetch latest docs from Anthropic
python fetch_claude_docs.py

Repository Structure

claude-code-docs/
├── docs/                    # All documentation markdown files
├── fetch_claude_docs.py     # Script to fetch from Anthropic
├── fetch_from_github.py     # Script to fetch from this repo
├── requirements.txt         # Python dependencies
├── .github/
│   └── workflows/
│       └── update-docs.yml  # Automatic update workflow
└── README.md               # This file

🔗 Stable URLs

📝 License

This is a community project. The documentation content belongs to Anthropic.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 100.0%