diff --git a/CLAUDE.md b/CLAUDE.md index 1ce62b6b3a..3a4e4e55ea 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -7,6 +7,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co This is the official Claude Code repository by Anthropic. It contains: - **Official plugins** in `plugins/` - extending Claude Code with commands, agents, hooks, and skills - **Example hooks** in `examples/hooks/` - sample hook implementations +- **Example settings** in `examples/settings/` - organization-wide settings deployment templates (lax, strict, bash-sandbox) - **Issue management scripts** in `scripts/` - TypeScript/Bun scripts for GitHub issue automation - **GitHub workflows** in `.github/workflows/` - CI/CD for issue triage, duplicate detection, and @claude mentions diff --git a/README.md b/README.md index 80aa75edf7..c15d123278 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,10 @@ For more installation options, uninstall steps, and troubleshooting, see the [se 2. Navigate to your project directory and run `claude`. +## Settings Examples + +The [`examples/settings/`](./examples/settings/) directory contains example configuration files for organization-wide Claude Code deployments, including lax, strict, and bash-sandbox presets. See the [settings examples README](./examples/settings/README.md) for details. + ## Plugins This repository includes several Claude Code plugins that extend functionality with custom commands and agents. See the [plugins directory](./plugins/README.md) for detailed documentation on available plugins. diff --git a/plugins/README.md b/plugins/README.md index cf4a21ecc5..662c5407ea 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -30,19 +30,25 @@ Learn more in the [official plugins documentation](https://docs.claude.com/en/do These plugins are included in the Claude Code repository. To use them in your own projects: -1. Install Claude Code globally: -```bash -npm install -g @anthropic-ai/claude-code -``` +1. Install Claude Code: -2. Navigate to your project and run Claude Code: -```bash -claude -``` + **MacOS/Linux (Recommended):** + ```bash + curl -fsSL https://claude.ai/install.sh | bash + ``` + + **Windows (Recommended):** + ```powershell + irm https://claude.ai/install.ps1 | iex + ``` + + For more installation options, see the [setup documentation](https://code.claude.com/docs/en/setup). + +2. Navigate to your project and run `claude`. 3. Use the `/plugin` command to install plugins from marketplaces, or configure them in your project's `.claude/settings.json`. -For detailed plugin installation and configuration, see the [official documentation](https://docs.claude.com/en/docs/claude-code/plugins). +For detailed plugin installation and configuration, see the [official documentation](https://code.claude.com/docs/en/plugins). ## Plugin Structure