Skip to content

README.md

Latest commit

 

History

History
124 lines (88 loc) · 4.21 KB

README.md

File metadata and controls

124 lines (88 loc) · 4.21 KB

codeguilds CLI

The official CLI for CodeGuilds — install Claude Code skills, agents, MCP servers, hooks, prompts, and CLAUDE.md templates in one command.

Install

npm install -g codeguilds

Or run without installing:

npx codeguilds install <slug>

Commands

codeguilds install <slug>

Install a package from the registry.

codeguilds install context7          # MCP server → ~/.claude/settings.json
codeguilds install my-skill          # Skill → ~/.claude/commands/
codeguilds install my-agent          # Agent → ~/.claude/agents/
codeguilds install my-template       # CLAUDE.md template → ./CLAUDE.md (append)
codeguilds install my-template --strategy prepend   # prepend instead
codeguilds install my-hook           # Hook → ~/.claude/settings.json
codeguilds install my-mcp --project  # Project-local install

codeguilds search <query>

Search the registry.

codeguilds search github
codeguilds search "code review"

codeguilds info <slug>

Show details about a package.

codeguilds list

List locally installed packages.

codeguilds uninstall <slug>

Remove a package and undo configuration changes.

codeguilds login

Authenticate with your CodeGuilds account (optional). Invokes the OS browser opener (open on macOS, xdg-open on Linux, start on Windows) to launch the OAuth flow, then saves credentials to ~/.codeguilds/auth.json. All core operations (install, search, info) work without an account. Login is currently a foundation for upcoming features like rating packages and following authors.

codeguilds logout

Clear saved credentials.

codeguilds collection list

Browse featured collections from the registry.

codeguilds collection info <slug>

Show collection details and package list.

codeguilds collection install <slug>

Install all packages in a collection (prompts for confirmation).

codeguilds collection install react-nextjs-dev
codeguilds collection install react-nextjs-dev --yes  # skip confirmation

How it works

Each package in the registry stores an install_config that tells the CLI exactly where to place the package:

Type Installed to
mcp_server ~/.claude/settings.json → mcpServers
hook ~/.claude/settings.json → hooks
skill / prompt ~/.claude/commands/
agent ~/.claude/agents/
claude_md_template ./CLAUDE.md (merged) or ~/.claude/CLAUDE.md

File System

The CLI writes to these locations:

Path Purpose
~/.claude/settings.json MCP servers and hooks (added/removed on install/uninstall)
~/.claude/commands/<filename> Skills and prompts
~/.claude/agents/<filename> Agents
./CLAUDE.md or ~/.claude/CLAUDE.md CLAUDE.md templates (merged)
~/.codeguilds/auth.json Login session token (created only on codeguilds login)
./.codeguilds-lock.json Lock file tracking installed packages (written in current directory on install/uninstall)

All writes are explicit — triggered only by install, uninstall, or login commands. Nothing runs automatically.

Network Requests

The CLI makes requests to:

  • codeguilds.dev registry (Supabase) — package lookups, search, and anonymous usage analytics (command type + package slug, no personal data collected)
  • raw.githubusercontent.com — infer MCP install config from GitHub repos when not stored in the registry (unauthenticated)
  • localhost (127.0.0.1, random port 10000–60000) — temporary HTTP server during codeguilds login to receive the OAuth callback; shut down immediately after

No requests are made to the Anthropic API.

Requirements

  • Node.js 18+
  • Claude Code installed

Registry

Browse, search, and publish packages at codeguilds.dev.

License

MIT