Skip to content

INSTALL.md

Latest commit

 

History

History
141 lines (93 loc) · 3.33 KB

INSTALL.md

File metadata and controls

141 lines (93 loc) · 3.33 KB
Raw

Installation Guide

Complete installation guide for Claude Code, dependencies, and this configuration.

Use the plugin marketplace to install agents/commands/hooks/MCP. You'll still need to complete prerequisites and create the AGENTS.md symlink.

Prerequisites

Claude Code

Install Claude Code using the native installer (no Node.js required):

macOS/Linux/WSL:

# Install via native installer
curl -fsSL https://claude.ai/install.sh | bash

# Or via Homebrew
brew install --cask claude-code

# Verify installation
claude --version

Windows PowerShell:

# Install via native installer
irm https://claude.ai/install.ps1 | iex

# Verify installation
claude --version

Migrate from legacy npm installation:

claude install

Optionally install IDE extension:

OpenAI Codex

Install OpenAI Codex:

npm install -g @openai/codex

Optionally install IDE extension:

Codex Plugins

# Add marketplace (one time)
codex plugin marketplace add fcakyon/claude-codex-settings

# Install any plugin by name
codex plugin add simplify@claude-settings

Gemini CLI

Install Gemini CLI:

npm install -g @anthropic-ai/gemini-cli

Install individual plugins:

gemini extensions install --path ./plugins/simplify

Required Tools

jq (JSON processor - required for hooks)

# macOS
brew install jq

# Ubuntu/Debian
sudo apt-get install jq

# No sudo: local binary
mkdir -p ~/.local/bin
curl -Lo ~/.local/bin/jq https://github.com/jqlang/jq/releases/latest/download/jq-linux-amd64
chmod +x ~/.local/bin/jq

GitHub CLI (required for github-dev plugin)

# macOS
brew install gh

# Ubuntu/Debian
sudo apt-get install gh

# No sudo: local binary
mkdir -p ~/.local/bin
GH_VERSION=$(curl -s https://api.github.com/repos/cli/cli/releases/latest | grep tag_name | cut -d '"' -f 4 | sed 's/v//')
curl -Lo gh.tar.gz "https://github.com/cli/cli/releases/latest/download/gh_${GH_VERSION}_linux_amd64.tar.gz"
tar xzf gh.tar.gz --strip-components=1 -C ~/.local/bin "gh_${GH_VERSION}_linux_amd64/bin/gh"
rm gh.tar.gz

If using local binaries, add ~/.local/bin to PATH: export PATH="$HOME/.local/bin:$PATH"

Code Quality Tools

# Python formatting (required for Python hook)
uv tool install ruff

# Prettier for JS/TS/CSS/JSON/YAML/HTML/Markdown/Shell formatting (required for prettier hooks)
npm install -g prettier@3.6.2 prettier-plugin-sh

Verify both are on PATH: ruff --version && npx prettier --version. The Python, prettier, and bash hooks exit without a message when a tool is missing, so nothing gets formatted and nothing warns you.

Post-Installation Setup

Create Shared Agent Guidance

Create symlinks for cross-tool compatibility (AGENTS.md):

ln -sfn CLAUDE.md AGENTS.md
ln -sfn CLAUDE.md GEMINI.md

This lets tools like OpenAI Codex, Gemini CLI, Cursor, Github Copilot and Qwen Code reuse the same instructions.