{"id":30522948,"url":"https://github.com/mnestorov/cc-docs-mirror","last_synced_at":"2026-04-20T14:02:15.545Z","repository":{"id":311078504,"uuid":"1042387504","full_name":"mnestorov/cc-docs-mirror","owner":"mnestorov","description":"Local mirror of Claude Code documentation files from docs.anthropic.com, automatically updated with semantic versioning.","archived":false,"fork":false,"pushed_at":"2025-12-05T09:06:32.000Z","size":967,"stargazers_count":2,"open_issues_count":254,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-08T17:59:05.095Z","etag":null,"topics":["claude","claude-code","claude-code-commands","claude-code-hooks"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mnestorov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-22T00:06:51.000Z","updated_at":"2025-12-05T09:06:36.000Z","dependencies_parsed_at":"2025-08-22T02:30:43.307Z","dependency_job_id":"dd7ef867-ba41-4456-ac86-ff48990c91e4","html_url":"https://github.com/mnestorov/cc-docs-mirror","commit_stats":null,"previous_names":["mnestorov/cc-docs-mirror"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/mnestorov/cc-docs-mirror","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnestorov%2Fcc-docs-mirror","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnestorov%2Fcc-docs-mirror/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnestorov%2Fcc-docs-mirror/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnestorov%2Fcc-docs-mirror/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mnestorov","download_url":"https://codeload.github.com/mnestorov/cc-docs-mirror/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mnestorov%2Fcc-docs-mirror/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32050451,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T11:35:06.609Z","status":"ssl_error","status_checked_at":"2026-04-20T11:34:48.899Z","response_time":94,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["claude","claude-code","claude-code-commands","claude-code-hooks"],"created_at":"2025-08-26T19:43:38.905Z","updated_at":"2026-04-20T14:02:15.521Z","avatar_url":"https://github.com/mnestorov.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Claude Code Documentation Mirror\n\n[![Last Update](https://img.shields.io/github/last-commit/mnestorov/cc-docs-mirror/main.svg?label=docs%20updated)](https://github.com/mnestorov/cc-docs-mirror/commits/main)\n[![Version](https://img.shields.io/badge/version-1.0.0-green)](https://github.com/mnestorov/cc-docs-mirror/releases)\n[![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux-blue)]()\n\nLocal mirror of Claude Code documentation files from https://docs.anthropic.com/en/docs/claude-code/, automatically updated with semantic versioning.\n\n## 🚀 Quick Start\n\n**One-command installation:**\n\n```bash\ncurl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs-mirror/main/scripts/bin/install.sh | bash\n```\n\nThis sets up the `/docs` command in Claude Code with automatic updates.\n\n## ✨ Features\n\n- **📖 Instant documentation access** - Read docs without web delays\n- **🔄 Automatic updates** - Stays current with latest Claude Code docs\n- **📋 Changelog integration** - Access Claude Code release notes with `/docs changelog`\n- **🔍 Smart search** - Find docs with natural language queries\n- **🍎 Cross-platform** - Works on macOS and Linux\n- **⚡ Fast** - Local files mean instant access\n\n## 💡 Usage\n\n### Basic commands\n```bash\n/docs                    # List all available documentation\n/docs hooks             # Read hooks documentation instantly\n/docs mcp               # Read MCP documentation\n/docs changelog         # Read Claude Code release notes\n```\n\n### Check for updates\n```bash\n/docs -t                # Check sync status with GitHub\n/docs -t hooks          # Check updates, then read hooks docs\n```\n\n### What's new\n```bash\n/docs what's new        # See recent documentation changes\n```\n\n### Natural language\n```bash\n/docs how do I use environment variables?\n/docs explain memory management\n/docs find all mentions of authentication\n```\n\n## 🛠️ Development\n\n### Prerequisites\n- **git** - Repository management\n- **jq** - JSON processing \n- **curl** - Downloads\n- **python3** - For documentation fetching (optional)\n- **Claude Code** - Obviously! 😄\n\n### Manual Installation\n```bash\ngit clone https://github.com/mnestorov/cc-docs-mirror.git\ncd cc-docs\n./scripts/bin/install.sh\n```\n\n### Documentation Fetching (Advanced)\nThe project includes an enhanced Python script for fetching documentation with progress visualization:\n\n```bash\n# Install Python dependencies\ncd scripts\npip install -r requirements.txt\n\n# Run the documentation fetcher\npython fetch_claude_docs.py\n```\n\n**Features:**\n- 📊 **Progress bars** with real-time updates\n- 🔄 **Smart retry logic** with exponential backoff  \n- ✅ **Content validation** to ensure quality\n- 📈 **Detailed statistics** and success rates\n- 🎯 **Automatic discovery** of new documentation pages\n\n### Project Structure\n```\ncc-docs/\n├── docs/                    # Mirror of official documentation\n├── scripts/\n│   ├── fetch_claude_docs.py # Enhanced documentation fetcher\n│   ├── requirements.txt     # Python dependencies\n│   └── bin/                 # Shell scripts\n│       ├── install.sh       # Main installer\n│       ├── claude-docs-helper.sh # Core functionality\n│       ├── uninstall.sh     # Uninstaller\n│       └── update-version.sh # Version updater\n├── .github/workflows/       # GitHub Actions for automation\n├── package.json            # Semantic release configuration\n└── .releaserc.json         # Release automation rules\n```\n\n## 🔄 How Updates Work\n\n1. **GitHub Actions** fetches documentation changes every few hours\n2. **Semantic versioning** tracks releases automatically  \n3. **Pre-tool hooks** check for updates when you read docs\n4. **Git pull** updates happen automatically when new content is available\n\n## 🆘 Troubleshooting\n\n### Command not found\n```bash\n# Check if command exists\nls ~/.claude/commands/docs.md\n\n# Restart Claude Code and try again\n# Or reinstall:\ncurl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs-mirror/main/scripts/bin/install.sh | bash\n```\n\n### Documentation seems outdated\n```bash\n# Force update check\n/docs -t\n\n# Manual update\ncd ~/.claude-code-docs \u0026\u0026 git pull\n```\n\n### Installation issues\n1. **Missing dependencies**: Install `git`, `jq`, `curl`\n2. **Permission errors**: Check `~/.claude/` directory permissions  \n3. **Network issues**: Check if GitHub Actions are running: [View Actions](https://github.com/mnestorov/cc-docs-mirror/actions)\n\n## 🗑️ Uninstalling\n\n### Quick Uninstall\n\nFrom anywhere, run:\n```bash\n~/.claude-code-docs/scripts/bin/uninstall.sh\n```\n\nOr use the docs command:\n```bash\n/docs uninstall\n```\n\n### What Gets Removed\n\nThe uninstaller will remove:\n\n1. **The /docs command** from `~/.claude/commands/docs.md`\n2. **The auto-update hook** from `~/.claude/settings.json`\n3. **The installation directory** `~/.claude-code-docs`\n\n### Manual Uninstall\n\nIf you prefer to uninstall manually:\n\n1. **Remove the command file:**\n```bash\nrm -f ~/.claude/commands/docs.md\n```\n\n2. **Remove the hook from Claude settings:**\nEdit `~/.claude/settings.json` to remove the PreToolUse hook that references claude-code-docs.\n\n3. **Remove the installation directory:**\n```bash\nrm -rf ~/.claude-code-docs\n```\n\n### Multiple Installations\n\nIf you have multiple installations, the uninstaller will notify you about other locations it finds. You'll need to remove each one separately.\n\nTo find all installations:\n```bash\nfind ~ -name \"claude-code-docs\" -type d 2\u003e/dev/null | grep -v \".claude-code-docs\"\n```\n\n### Backup Created\n\nThe uninstaller creates a backup of your Claude settings at `~/.claude/settings.json.backup` before removing hooks, just in case.\n\n### Reinstalling\n\nTo reinstall after uninstalling:\n```bash\ncurl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs-mirror/main/scripts/bin/install.sh | bash\n```\n\n## 🤝 Contributing\n\nWe welcome contributions from the community! Please see our [Contributing Guidelines](CONTRIBUTING.md) for detailed information.\n\n### Quick Start for Contributors\n\n1. **Fork \u0026 Clone**:\n   ```bash\n   git clone https://github.com/YOUR_USERNAME/cc-docs-mirror.git\n   cd cc-docs-mirror\n   npm install\n   ```\n\n2. **Make Changes** following our conventions:\n   - Use conventional commits (`feat:`, `fix:`, `docs:`)\n   - Test your changes locally\n   - Update documentation as needed\n\n3. **Submit a Pull Request** with a clear description\n\n### Ways to Contribute\n\n- 🪟 **Windows Support**: Help make scripts work on Windows (high priority!)\n- 🐛 **Bug Reports**: [Open an issue](https://github.com/mnestorov/cc-docs-mirror/issues) with reproduction steps\n- 💡 **Feature Requests**: [Start a discussion](https://github.com/mnestorov/cc-docs-mirror/discussions) for new ideas\n- 📝 **Documentation**: Improve guides, add examples, fix typos\n- ⚡ **Performance**: Optimize fetching and processing speed\n- 🌍 **Translations**: Help internationalize the project\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for complete guidelines, code style, and development setup.\n\n## 🔒 Security\n\n- Repository cloned over HTTPS from GitHub\n- All operations confined to `~/.claude-code-docs`\n- No external data transmission (beyond git operations)\n- Hooks only run `git pull` for documentation updates\n\nFor additional security, you can fork the repository and install from your own fork.\n\n## 📜 License\n\nDocumentation content belongs to Anthropic.  \nThis mirror tool is open source under MIT license.\n\n## 📈 Project Status\n\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/mnestorov/cc-docs-mirror)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mnestorov/cc-docs-mirror/release.yml)\n![GitHub contributors](https://img.shields.io/github/contributors/mnestorov/cc-docs-mirror)\n![GitHub issues](https://img.shields.io/github/issues/mnestorov/cc-docs-mirror)\n\n## 🗺️ Roadmap\n\n- [ ] 🪟 Windows support\n- [ ] 🔍 Enhanced search capabilities\n- [ ] 📱 Better mobile/terminal UI\n- [ ] 🌐 Offline-first improvements\n- [ ] 🎨 Customizable themes\n- [ ] 📊 Usage analytics (optional)\n- [ ] 🌍 Multi-language support\n\n## 👥 Contributors\n\nThanks to all contributors who help make this project better!\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nWant to see your name here? Check out our [Contributing Guidelines](CONTRIBUTING.md)!\n\n## 🙏 Acknowledgments\n\n- **Anthropic** for Claude Code and excellent documentation\n- **Community contributors** who help improve this tool\n- **Claude Code users** who provide feedback and feature requests\n- **Open source community** for inspiration and best practices\n\n## 📞 Support\n\n- 📖 **Documentation**: Check the sections above\n- 💬 **Discussions**: [GitHub Discussions](https://github.com/mnestorov/cc-docs-mirror/discussions)\n- 🐛 **Bug Reports**: [GitHub Issues](https://github.com/mnestorov/cc-docs-mirror/issues)\n- 📧 **Contact**: Open an issue for questions\n\n---\n\n\u003cdiv align=\"center\"\u003e\n\n**Made with ❤️ for the community**\n\n[Report Bug](https://github.com/mnestorov/cc-docs-mirror/issues) · [Request Feature](https://github.com/mnestorov/cc-docs-mirror/discussions) · [Contributing](CONTRIBUTING.md)\n\n\u003c/div\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmnestorov%2Fcc-docs-mirror","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmnestorov%2Fcc-docs-mirror","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmnestorov%2Fcc-docs-mirror/lists"}