Skip to content

Commit fe417e7

Browse files
committed
feat: initial commit - Claude Code documentation mirror
1 parent f6abc67 commit fe417e7

File tree

6 files changed

+26
-26
lines changed

6 files changed

+26
-26
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Claude Code Documentation Mirror
22

3-
[![Last Update](https://img.shields.io/github/last-commit/mnestorov/cc-docs/main.svg?label=docs%20updated)](https://github.com/mnestorov/cc-docs/commits/main)
4-
[![Version](https://img.shields.io/badge/version-1.0.0-green)](https://github.com/mnestorov/cc-docs/releases)
3+
[![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)
4+
[![Version](https://img.shields.io/badge/version-1.0.0-green)](https://github.com/mnestorov/cc-docs-mirror/releases)
55
[![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux-blue)]()
66

77
Local mirror of Claude Code documentation files from https://docs.anthropic.com/en/docs/claude-code/, automatically updated with semantic versioning.
@@ -11,7 +11,7 @@ Local mirror of Claude Code documentation files from https://docs.anthropic.com/
1111
**One-command installation:**
1212

1313
```bash
14-
curl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs/main/scripts/bin/install.sh | bash
14+
curl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs-mirror/main/scripts/bin/install.sh | bash
1515
```
1616

1717
This sets up the `/docs` command in Claude Code with automatic updates.
@@ -64,7 +64,7 @@ This sets up the `/docs` command in Claude Code with automatic updates.
6464
6565
### Manual Installation
6666
```bash
67-
git clone https://github.com/mnestorov/cc-docs.git
67+
git clone https://github.com/mnestorov/cc-docs-mirror.git
6868
cd cc-docs
6969
./scripts/bin/install.sh
7070
```
@@ -121,7 +121,7 @@ ls ~/.claude/commands/docs.md
121121
122122
# Restart Claude Code and try again
123123
# Or reinstall:
124-
curl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs/main/scripts/bin/install.sh | bash
124+
curl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs-mirror/main/scripts/bin/install.sh | bash
125125
```
126126
127127
### Documentation seems outdated
@@ -136,7 +136,7 @@ cd ~/.claude-code-docs && git pull
136136
### Installation issues
137137
1. **Missing dependencies**: Install `git`, `jq`, `curl`
138138
2. **Permission errors**: Check `~/.claude/` directory permissions
139-
3. **Network issues**: Check if GitHub Actions are running: [View Actions](https://github.com/mnestorov/cc-docs/actions)
139+
3. **Network issues**: Check if GitHub Actions are running: [View Actions](https://github.com/mnestorov/cc-docs-mirror/actions)
140140
141141
## 🗑️ Uninstalling
142142
@@ -194,16 +194,16 @@ The uninstaller creates a backup of your Claude settings at `~/.claude/settings.
194194

195195
To reinstall after uninstalling:
196196
```bash
197-
curl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs/main/scripts/bin/install.sh | bash
197+
curl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs-mirror/main/scripts/bin/install.sh | bash
198198
```
199199

200200
## 🤝 Contributing
201201

202202
We welcome contributions! Here's how you can help:
203203
204-
- 🪟 **Windows Support**: Want to help add Windows compatibility? [Fork the repository](https://github.com/mnestorov/cc-docs/fork) and submit a PR!
205-
- 🐛 **Bug Reports**: Found something not working? [Open an issue](https://github.com/mnestorov/cc-docs/issues)
206-
- 💡 **Feature Requests**: Have an idea? [Start a discussion](https://github.com/mnestorov/cc-docs/issues)
204+
- 🪟 **Windows Support**: Want to help add Windows compatibility? [Fork the repository](https://github.com/mnestorov/cc-docs-mirror/fork) and submit a PR!
205+
- 🐛 **Bug Reports**: Found something not working? [Open an issue](https://github.com/mnestorov/cc-docs-mirror/issues)
206+
- 💡 **Feature Requests**: Have an idea? [Start a discussion](https://github.com/mnestorov/cc-docs-mirror/issues)
207207
- 📝 **Documentation**: Help improve docs or add examples
208208
209209
You can use Claude Code itself to help build features - just fork the repo and let Claude assist you!
@@ -230,4 +230,4 @@ This mirror tool is open source under MIT license.
230230
231231
---
232232
233-
**Need help?** [Open an issue](https://github.com/mnestorov/cc-docs/issues) or check the [troubleshooting section](#-troubleshooting) above.
233+
**Need help?** [Open an issue](https://github.com/mnestorov/cc-docs-mirror/issues) or check the [troubleshooting section](#-troubleshooting) above.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"description": "Local mirror of Claude Code documentation with auto-sync",
55
"repository": {
66
"type": "git",
7-
"url": "https://github.com/mnestorov/cc-docs.git"
7+
"url": "https://github.com/mnestorov/cc-docs-mirror.git"
88
},
99
"private": false,
1010
"scripts": {

scripts/bin/claude-docs-helper.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ sanitize_input() {
2323

2424
# Function to print documentation header
2525
print_doc_header() {
26-
echo "📚 COMMUNITY MIRROR: https://github.com/mnestorov/cc-docs"
26+
echo "📚 COMMUNITY MIRROR: https://github.com/mnestorov/cc-docs-mirror"
2727
echo "📖 OFFICIAL DOCS: https://docs.anthropic.com/en/docs/claude-code"
2828
echo ""
2929
}
@@ -83,7 +83,7 @@ show_freshness() {
8383
if [[ ! -f "$MANIFEST" ]]; then
8484
echo "❌ Error: Documentation not found at ~/.claude-code-docs"
8585
echo "Please reinstall with:"
86-
echo "curl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs/main/install.sh | bash"
86+
echo "curl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs-mirror/main/install.sh | bash"
8787
exit 1
8888
fi
8989

@@ -270,7 +270,7 @@ whats_new() {
270270
local date=$(git show -s --format=%cr "$hash" 2>/dev/null || echo "unknown")
271271

272272
echo "$date:"
273-
echo " 📎 https://github.com/mnestorov/cc-docs/commit/$hash"
273+
echo " 📎 https://github.com/mnestorov/cc-docs-mirror/commit/$hash"
274274

275275
# Show which docs changed
276276
local changed_docs=$(git diff-tree --no-commit-id --name-only -r "$hash" -- docs/*.md 2>/dev/null | sed 's|docs/||' | sed 's|\.md$||' | head -5)
@@ -288,7 +288,7 @@ whats_new() {
288288
echo ""
289289
fi
290290

291-
echo "📎 Full changelog: https://github.com/mnestorov/cc-docs/commits/main/docs"
291+
echo "📎 Full changelog: https://github.com/mnestorov/cc-docs-mirror/commits/main/docs"
292292
echo "📚 COMMUNITY MIRROR - NOT AFFILIATED WITH ANTHROPIC"
293293

294294
# Re-enable strict error handling

scripts/bin/install.sh

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ migrate_installation() {
133133

134134
# Fresh install at new location
135135
echo "Installing fresh at ~/.claude-code-docs..."
136-
git clone -b "$INSTALL_BRANCH" https://github.com/mnestorov/cc-docs.git "$INSTALL_DIR"
136+
git clone -b "$INSTALL_BRANCH" https://github.com/mnestorov/cc-docs-mirror.git "$INSTALL_DIR"
137137
cd "$INSTALL_DIR"
138138

139139
# Remove old directory if safe
@@ -368,7 +368,7 @@ else
368368
echo "No existing installation found"
369369
echo "Installing fresh to ~/.claude-code-docs..."
370370

371-
git clone -b "$INSTALL_BRANCH" https://github.com/mnestorov/cc-docs.git "$INSTALL_DIR"
371+
git clone -b "$INSTALL_BRANCH" https://github.com/mnestorov/cc-docs-mirror.git "$INSTALL_DIR"
372372
cd "$INSTALL_DIR"
373373
fi
374374
fi
@@ -386,7 +386,7 @@ if [[ -f "$INSTALL_DIR/scripts/claude-docs-helper.sh.template" ]]; then
386386
else
387387
echo " ⚠️ Template file missing, attempting recovery..."
388388
# Try to fetch just the template file
389-
if curl -fsSL "https://raw.githubusercontent.com/mnestorov/cc-docs/$INSTALL_BRANCH/scripts/claude-docs-helper.sh.template" -o "$INSTALL_DIR/claude-docs-helper.sh" 2>/dev/null; then
389+
if curl -fsSL "https://raw.githubusercontent.com/mnestorov/cc-docs-mirror/$INSTALL_BRANCH/scripts/claude-docs-helper.sh.template" -o "$INSTALL_DIR/claude-docs-helper.sh" 2>/dev/null; then
390390
chmod +x "$INSTALL_DIR/claude-docs-helper.sh"
391391
echo " ✓ Helper script downloaded directly"
392392
else
@@ -419,7 +419,7 @@ Usage:
419419
Examples of expected output:
420420
421421
When reading a doc:
422-
📚 COMMUNITY MIRROR: https://github.com/mnestorov/cc-docs
422+
📚 COMMUNITY MIRROR: https://github.com/mnestorov/cc-docs-mirror
423423
📖 OFFICIAL DOCS: https://docs.anthropic.com/en/docs/claude-code
424424
425425
[Doc content here...]
@@ -430,13 +430,13 @@ When showing what's new:
430430
📚 Recent documentation updates:
431431
432432
• 5 hours ago:
433-
📎 https://github.com/mnestorov/cc-docs/commit/eacd8e1
433+
📎 https://github.com/mnestorov/cc-docs-mirror/commit/eacd8e1
434434
📄 data-usage: https://docs.anthropic.com/en/docs/claude-code/data-usage
435435
➕ Added: Privacy safeguards
436436
📄 security: https://docs.anthropic.com/en/docs/claude-code/security
437437
✨ Data flow and dependencies section moved here
438438
439-
📎 Full changelog: https://github.com/mnestorov/cc-docs/commits/main/docs
439+
📎 Full changelog: https://github.com/mnestorov/cc-docs-mirror/commits/main/docs
440440
📚 COMMUNITY MIRROR - NOT AFFILIATED WITH ANTHROPIC
441441
442442
Every request checks for the latest documentation from GitHub (takes ~0.4s).

scripts/bin/uninstall.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,4 +135,4 @@ echo ""
135135
echo "✅ Uninstall complete!"
136136
echo ""
137137
echo "To reinstall:"
138-
echo "curl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs/main/install.sh | bash"
138+
echo "curl -fsSL https://raw.githubusercontent.com/mnestorov/cc-docs-mirror/main/install.sh | bash"

scripts/fetch_claude_docs.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,13 @@ def save_manifest(docs_dir: Path, manifest: dict) -> None:
8787
manifest["last_updated"] = datetime.now().isoformat()
8888

8989
# Get GitHub repository from environment or use default
90-
github_repo = os.environ.get('GITHUB_REPOSITORY', 'mnestorov/cc-docs')
90+
github_repo = os.environ.get('GITHUB_REPOSITORY', 'mnestorov/cc-docs-mirror')
9191
github_ref = os.environ.get('GITHUB_REF_NAME', 'main')
9292

9393
# Validate repository name format (owner/repo)
9494
if not re.match(r'^[\w.-]+/[\w.-]+$', github_repo):
9595
logger.warning(f"Invalid repository format: {github_repo}, using default")
96-
github_repo = 'mnestorov/cc-docs'
96+
github_repo = 'mnestorov/cc-docs-mirror'
9797

9898
# Validate branch/ref name
9999
if not re.match(r'^[\w.-]+$', github_ref):
@@ -535,7 +535,7 @@ def main():
535535
logger.info("Starting Claude Code documentation fetch")
536536

537537
# Log configuration
538-
github_repo = os.environ.get('GITHUB_REPOSITORY', 'mnestorov/cc-docs')
538+
github_repo = os.environ.get('GITHUB_REPOSITORY', 'mnestorov/cc-docs-mirror')
539539
logger.info(f"GitHub repository: {github_repo}")
540540

541541
# Create docs directory at repository root

0 commit comments

Comments
 (0)