Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"plugins": [
{
"name": "claude-docs",
"description": "Searchable local mirror of Claude documentation — always fresh, always available",
"source": "./plugin"
}
]
}
2 changes: 1 addition & 1 deletion .github/workflows/update-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ jobs:
id: commit-msg
run: |
# Stage changes to see what will be committed
git add -A docs/
git add -A docs/ paths_manifest.json

# Get list of changed files with proper quoting
# Using printf with %q for shell-safe quoting would be ideal, but not available in all shells
Expand Down
42 changes: 25 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,47 +66,55 @@ The magic is in combining a simple local file system with Claude's language unde

## Installation

### Quick Install (2 minutes)
### Method 1: Plugin Install (Recommended)

If you have Claude Code with plugin support:

**One command:**
```bash
curl -fsSL https://raw.githubusercontent.com/costiash/claude-code-docs/main/install.sh | bash
/plugin marketplace add costiash/claude-code-docs
/plugin install claude-docs
```

**What it does:**
1. Clones repository to `~/.claude-code-docs`
2. Installs 571 documentation files
3. Sets up `/docs` command in Claude Code
4. Verifies installation integrity
1. Installs the claude-docs plugin (provides /docs command + auto-discovery Skill)
2. On first session, automatically clones documentation to `~/.claude-code-docs/`
3. On each subsequent session, auto-updates docs via git pull

**Python features activate automatically if Python 3.9+ is installed.**
**Requirements:** Claude Code with plugin support

### Installation Methods
### Method 2: Script Install (Legacy)

For environments without plugin support:

**Method 1: Direct Install (interactive)**
```bash
curl -fsSL https://raw.githubusercontent.com/costiash/claude-code-docs/main/install.sh | bash
```
Works on: Local terminals, iTerm2, Terminal.app, SSH with `-t` flag

**Method 2: Auto-Install (CI/CD-friendly)**
**What it does:**
1. Clones repository to `~/.claude-code-docs`
2. Sets up `/docs` command in `~/.claude/commands/docs.md`
3. Installs helper scripts

**Requirements:** git, jq, curl. Optional: Python 3.9+ for enhanced search.

#### Script Install Variants

**Auto-Install (CI/CD-friendly):**
```bash
CLAUDE_DOCS_AUTO_INSTALL=yes curl -fsSL https://raw.githubusercontent.com/costiash/claude-code-docs/main/install.sh | bash
```
Works on: **All environments** including GitHub Actions, Docker, cron jobs, SSH without `-t`

**Method 3: Download First (most reliable)**
**Download First (most reliable):**
```bash
curl -fsSL https://raw.githubusercontent.com/costiash/claude-code-docs/main/install.sh -o install.sh
bash install.sh
```
Works on: All interactive shells

### Requirements

- **Required**: macOS 12+ or Linux (Ubuntu, Debian, Fedora, etc.)
- **Required**: git, jq, curl (usually pre-installed)
- **Optional**: Python 3.9+ (enables search/validation features)
- **Required**: git (both methods), jq + curl (script install only)
- **Optional**: Python 3.9+ (enables search/validation features in script install)

## Upgrading

Expand Down
Loading
Loading