https://github.com/thevibeworks/claude-code-docs
https://github.com/thevibeworks/claude-code-docs
ai-agents claude claude-code codex vibe-coding
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thevibeworks/claude-code-docs
- Owner: thevibeworks
- License: mit
- Created: 2025-06-24T03:58:44.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2026-03-31T03:47:48.000Z (3 months ago)
- Last Synced: 2026-03-31T05:59:59.792Z (3 months ago)
- Topics: ai-agents, claude, claude-code, codex, vibe-coding
- Language: TypeScript
- Homepage:
- Size: 38.3 MB
- Stars: 6
- Watchers: 0
- Forks: 2
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Start Vibe Coding with Claude Code
> 🤖 **Claude Code is Auto Managing this Repo**: This repository is automatically updated and managed by Claude via GitHub Actions. See `.github/workflows/` for automation details.
This repository contains Claude Code documentation and resources for **learning about [Claude Code](https://claude.ai/code)**
## Quick Start for How to Use Claude Code
### Prerequisites
First, install Claude Code CLI:
```bash
npm install -g @anthropic-ai/claude-code
```
### Getting Started
> **GitHub Repository**: https://github.com/thevibeworks/claude-code-docs
1. **Clone this repository**:
```bash
git clone https://github.com/thevibeworks/claude-code-docs
cd claude-code-docs
```
2. **Start using Claude Code with the documentation as context**:
```bash
claude "show me claude code workflow"
claude "what's the best practice for using claude code? what's ultrathink?"
claude "what are the main features of claude code?"
claude "how do I use claude code with github?"
claude "explain claude code memory management"
claude "how do I save money when using claude code?"
```
## Practical Usage Examples
Once you have this documentation repository, here's how to use it with Claude Code:
### Learning Claude Code Basics
```bash
claude "Based on the documentation in this repo, what is Claude Code?"
claude "How do I install and set up Claude Code for the first time?"
claude "What are the key features I should know about?"
claude "Show me the most important commands to get started"
```
### Understanding Advanced Features
```bash
claude "What is extended thinking and how do I use it?"
claude "How does Claude Code integrate with GitHub Actions?"
claude "What are MCP integrations and when should I use them?"
```
### Getting Help with Workflows
```bash
claude "Based on these docs, what's the recommended workflow for team collaboration?"
claude "How should I structure my prompts for better results?"
claude "What are common mistakes to avoid when using Claude Code?"
claude "Show me examples of effective Claude Code usage patterns"
```
### Troubleshooting with Documentation
```bash
claude "I'm having authentication issues - help me debug using the troubleshooting docs"
claude "Claude Code seems slow - what optimization tips are in the documentation?"
claude "How do I configure Claude Code according to the setup guide?"
```
### Configuring Claude Code Settings
```bash
claude "Based on the settings.md file, show me how to set up project-level permissions"
claude "How do I create a settings.json file to allow npm commands but deny curl?"
claude "What's the difference between .claude/settings.json and .claude/settings.local.json?"
claude "Help me configure environment variables for my team using the settings docs"
# Example: Set up permissions for a web development project
claude "Using the settings documentation, create a settings.json that allows npm scripts, git commands, but blocks network requests"
```
## Repository Structure
Documentation is organized as a 1:1 mirror of the official sitemap:
```
content/
├── en/ All English documentation
│ ├── docs/ 116 docs (Claude Code, Build with Claude, etc.)
│ ├── api/ 84 docs (Agent SDK, Admin API, etc.)
│ ├── resources/ 66 docs (Prompt library)
│ └── release-notes/ Release notes
├── blog/ Anthropic blog posts
├── claude-code-manifest.json NPM package info
└── CHANGELOG.md GitHub repository changelog
```
## Fetching Latest Documentation
This repo auto-updates via GitHub Actions every 6 hours. To manually fetch:
```bash
# Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh
# Fetch all docs
uv run scripts/fetcher.py
# Browse structure
uv run scripts/fetcher.py --tree
# Fetch specific section
uv run scripts/fetcher.py --section en/docs/claude-code
uv run scripts/fetcher.py --section en/api/agent-sdk
# Skip existing files (incremental update)
uv run scripts/fetcher.py --incremental
```
## Disclaimer
This is an unofficial mirror for **educational purposes**. For official documentation, visit https://docs.anthropic.com/claude-code. For commercial use, please consult Anthropic's [commercial terms](https://www.anthropic.com/legal/commercial-terms).
- **Documentation content** is sourced from https://docs.anthropic.com and https://www.anthropic.com
- **Repository code** (CHANGELOG.md, commits) is sourced from https://github.com/anthropics/claude-code
- **Redistribution** should comply with Anthropic's [commercial terms](https://www.anthropic.com/legal/commercial-terms)
- **Commercial use** of this content may require permission from Anthropic