Skip to main content

Forge production-ready AI agent projects — agents, slash commands, memory, CI/CD, and devcontainers in one command

Project description

claudeforge

Forge production-ready AI agent projects — agents, slash commands, memory, CI/CD, and devcontainers in one command.

npm version PyPI version License: MIT Node.js 18+ Python 3.8+

No API key required. Works with any Claude model — GitHub Copilot, Claude.ai, or any IDE with the Claude Code extension.


Requirements

Node.js 18+ is required regardless of how you install claudeforge. The CLI is built on Node.js — the pip package is a thin wrapper that delegates to it automatically.

Requirement Version Notes
Node.js 18+ Required for the CLI — install first
npm any Included with Node.js
Python 3.8+ Only needed if installing via pip
Claude Code latest IDE extension for slash commands

Install Node.js (if you don't have it)

# macOS
brew install node

# macOS / Linux — via nvm (recommended)
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
nvm install 20

# Ubuntu / Debian
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

# Windows — download installer from https://nodejs.org

Verify:

node --version   # should print v18 or higher

Table of Contents


What It Does

claudeforge gives you a production-ready Claude Code setup:

  • Interactive wizard (create) — go from zero to a fully configured project in one command
  • 9 slash commands for your daily workflow — /setup-project, /commit, /review-pr, /scaffold-structure, /standup, /fix-issue, /explain-codebase, /project-health, /memory-sync
  • A thorough code-reviewer agent that checks correctness, security, performance, test coverage, style, and documentation
  • GitHub Actions CI/CD auto-generated for your stack (Node, Python, Go, Rust)
  • VS Code devcontainer with the Claude Code extension pre-configured
  • Hook scripts that block dangerous operations before they run
  • A memory system that persists project context across every Claude session

Install

via npm (recommended)

Best if you already have Node.js installed.

npm install -g claudeforge-cli

via pip

Best if you primarily work in Python environments. Node.js 18+ must still be installed on your system (see Requirements above).

pip install claudeforge

The pip package is a thin wrapper — when you run claudeforge, it locates Node.js on your PATH and delegates all commands to the Node.js CLI automatically. No manual Node.js setup is required beyond having it installed.

Verify installation

claudeforge --version

Quick Start

Option A — Interactive wizard (fastest)

claudeforge create my-api

Walks you through project name, description, stack, and optional features (CI/CD, devcontainer, Docker). Then runs everything automatically.

Option B — Manual setup

# 1. Go to your project directory
cd my-project

# 2. Scaffold the Claude Code structure
claudeforge init

# 3. Generate CI/CD and devcontainer
claudeforge github

# 4. Prepare AI context (detects your tech stack automatically)
claudeforge project "FastAPI REST API with PostgreSQL and Redis"

# 5. Open the project in VS Code / JetBrains / any IDE with Claude Code
# 6. In the Claude Code chat window, run:
#    /setup-project "FastAPI REST API with PostgreSQL and Redis"

# Claude will fill in CLAUDE.md, settings, agents, commands, and memory
# tailored to your exact stack — no manual editing required.

# 7. Then run:
#    /scaffold-structure
# to create src/, tests/, and starter files for your stack.

CLI Commands

create — Interactive wizard

claudeforge create my-api
claudeforge create              # prompts for name
claudeforge create --dir ~/Projects

Walks you through:

  1. Project name
  2. Description (used by Claude to AI-configure everything)
  3. Tech stack selection
  4. Optional features: GitHub Actions CI/CD, devcontainer, Docker files

Then runs init, project, and github automatically — one command from zero to fully configured.


init — Scaffold project structure

claudeforge init
claudeforge init --dir ./my-project
claudeforge init --dry-run     # preview without writing
claudeforge init --force       # overwrite existing files

Creates 25 files across the full Claude Code structure. Run this once per project.

What gets created:

Path Purpose
.claude/settings.json Team-shared permissions, model, hooks
.claude/settings.local.json Personal overrides (gitignored)
.claude/agents/code-reviewer.md 7-category code review agent
.claude/commands/ 9 slash commands (see below)
.claude/hooks/pre-tool-use.sh Blocks rm -rf, curl|bash, .env edits
.claude/hooks/post-tool-use.sh Reminds to run tests after edits
.claude/rules/no-sensitive-files.md Rule: don't touch secrets
.claude/skills/project-conventions/ Style skill loaded before writing code
memory/MEMORY.md Index — always loaded by Claude
memory/user_profile.md Your role and preferences (gitignored)
memory/feedback_communication.md How Claude should behave
memory/project_ai_workflow.md AI conventions for this project
CLAUDE.md Project context template
CLAUDE.local.md Personal context (gitignored)
.mcp.json MCP servers (context7 pre-configured)
.env.example Environment variable documentation
.gitignore Covers secrets, local settings, OS artifacts

project — Prepare AI context

claudeforge project "describe your project in plain English"

Detects your tech stack from existing files (package.json, go.mod, requirements.txt, etc.), writes a SETUP_CONTEXT.md with full context, and tells you the exact command to run in Claude Code chat.

# Examples
claudeforge project "Next.js SaaS with Stripe, Prisma, and Clerk auth"
claudeforge project "Go gRPC microservice with PostgreSQL and Redis cache"
claudeforge project "Django REST API with Celery, RabbitMQ, and S3"
claudeforge project "Rust CLI tool for parsing and transforming CSV files"

After running, open Claude Code and run /setup-project "your description" in chat.


add — Scaffold agents, commands, skills

# Add a specialized agent
claudeforge add agent <name> [--description "..."] [--model sonnet|opus|haiku] [--color blue]

# Add a slash command
claudeforge add command <name> [--description "..."]

# Add a skill
claudeforge add skill <name> [--description "..."] [--no-user-invocable]
# Real examples
claudeforge add agent sql-reviewer \
  --description "Reviews SQL migrations for safety, performance, and rollback safety"

claudeforge add command deploy \
  --description "Run pre-deploy checks, deploy to staging, run smoke tests"

claudeforge add skill api-conventions \
  --description "Apply REST API naming and response conventions before writing endpoints"
Flag Description
--description <text> Frontmatter description (important — determines when Claude invokes it)
-f, --force Overwrite if file already exists
-d, --dir <path> Target directory
--model <model> (agent only) model override
--color <color> (agent only) color in Claude UI
--no-user-invocable (skill only) Claude-only, not user-invocable

github — CI/CD & devcontainer

claudeforge github
claudeforge github --dry-run          # preview without writing
claudeforge github --stack python     # force stack detection
claudeforge github --no-devcontainer  # skip devcontainer

Auto-detects your stack and generates:

Path Purpose
.github/workflows/ci.yml Lint, test, build on push/PR
.github/pull_request_template.md Structured PR checklist
.github/ISSUE_TEMPLATE/bug_report.md Bug report template
.github/ISSUE_TEMPLATE/feature_request.md Feature request template
.github/CODEOWNERS Ownership file
.devcontainer/devcontainer.json VS Code devcontainer with Claude Code

CI workflows are generated for: Node.js, Python, Go, Rust, and generic.


status — Show what's configured

claudeforge status
claudeforge status --dir ./my-project

Prints a full summary:

  Core Files        ✓ 8/8 present
  Settings          Model: claude-sonnet-4-6  |  13 allowed, 4 denied  |  2 hooks
  MCP Servers       context7, postgres
  Agents (3)        code-reviewer, api-reviewer, db-reviewer
  Slash Commands    9 commands configured
  Skills (2)        project-conventions, api-conventions
  Memory (4 files)  ● 3 filled  ○ 1 empty template

upgrade — Update built-in templates

claudeforge upgrade             # update hooks, rules, built-in commands
claudeforge upgrade --dry-run   # preview changes
claudeforge upgrade --all       # also update CLAUDE.md, settings.json, agents (⚠ overwrites edits)

By default, only infrastructure files are updated (hook scripts, rules, built-in slash commands). Your edited files (CLAUDE.md, settings.json, custom agents) are untouched.


Slash Commands (in IDE chat)

Run these in the Claude Code chat window in VS Code, JetBrains, or any Claude Code IDE. Works with any Claude model — no separate API key.

Setup & Maintenance

Command When to run What it does
/setup-project "description" After claudeforge init Fills in CLAUDE.md, settings, .env.example, .mcp.json, memory, generates 2–4 project-specific agents and commands, then documents every file it creates
/scaffold-structure After /setup-project Creates the actual src/, tests/, cmd/ directory structure with real starter files for your stack
/project-health Weekly / after big changes Audits your setup: checks CLAUDE.md completeness, hook coverage, memory fill level, and gives prioritized improvement suggestions
/memory-sync End of work session Reviews the session and updates memory/ files with preferences, decisions, and project context

Daily Development

Command When to run What it does
/commit After completing a feature Reads git diff, stages relevant files, writes a conventional commit message
/review-pr Before opening a PR Reviews the branch diff — correctness, security, tests, style — with severity ratings
/fix-issue "error message" When something breaks Locates the bug, forms a hypothesis, makes a minimal targeted fix, verifies with tests
/standup ["last 3 days"] Morning standup Generates a concise update from recent git commits and open PRs
/explain-codebase ["area"] Onboarding / exploring Explains architecture, key flows, and what to read first

What Gets Scaffolded

code-reviewer Agent (7 categories)

Reviews changed code across:

  1. Correctness — logic errors, edge cases, async issues
  2. Security — hardcoded secrets, injection, path traversal, SSRF
  3. Error Handling — swallowed errors, missing timeouts, resource leaks
  4. Performance — N+1 queries, unbounded growth, blocking calls
  5. Test Coverage — happy path, error paths, edge cases, assertions
  6. Style — naming, magic numbers, dead code, DRY
  7. Documentation — missing docstrings, stale docs, changelog

Returns: ✓ LGTM / ~ LGTM with suggestions / ⚠ Address warnings / ✗ Needs changes

Hook Scripts (auto-chmod 755)

pre-tool-use.sh blocks before every tool call:

  • rm -rf on absolute paths outside /tmp
  • Editing .env, credentials, key files (warns first)
  • curl | bash and wget | sh patterns

post-tool-use.sh injects reminders:

  • Prompts to run tests after editing test files

Memory System

Four structured memory files — Claude reads them every session:

File What it stores Gitignored?
MEMORY.md Index of all memory files No
user_profile.md Your role, background, preferences Yes
feedback_communication.md How Claude should behave No
project_ai_workflow.md AI conventions for this project No

How It Works

┌─────────────────────────────┐     ┌──────────────────────────────┐
│   Terminal CLI               │     │   Claude Code (IDE chat)      │
│                             │     │                               │
│  create my-api  ────────────┼─────┼▶  init + project + github    │
│                             │     │                               │
│  init           ────────────┼─────┼▶  .claude/ structure created  │
│  project "..."  ────────────┼─────┼▶  SETUP_CONTEXT.md written   │
│  github         ────────────┼─────┼▶  CI/CD + devcontainer       │
│                             │     │                               │
│                             │◀────┼─  /setup-project "..."        │
│                             │     │    ↳ fills CLAUDE.md          │
│                             │     │    ↳ updates settings.json   │
│                             │     │    ↳ creates agents          │
│                             │     │    ↳ creates commands        │
│                             │     │    ↳ documents every file    │
│                             │     │                               │
│                             │◀────┼─  /scaffold-structure         │
│                             │     │    ↳ creates src/, tests/    │
│                             │     │    ↳ writes starter files    │
│                             │     │                               │
│  add agent ...  ────────────┼─────┼▶  template created           │
│  status         ────────────┼─────┼▶  summary printed            │
│  upgrade        ────────────┼─────┼▶  hooks/rules updated        │
└─────────────────────────────┘     └──────────────────────────────┘

The CLI handles file scaffolding. The AI work happens inside the IDE where Claude has full tool access to read, write, and run commands — no separate API key needed.


Troubleshooting

claudeforge: command not found after npm install

# Ensure npm global bin is on PATH
export PATH="$(npm prefix -g)/bin:$PATH"
# Add to ~/.zshrc or ~/.bashrc to persist

claudeforge: command not found after pip install

# Ensure pip user bin is on PATH
export PATH="$HOME/.local/bin:$PATH"
# Add to ~/.zshrc or ~/.bashrc to persist

Node.js is required but was not found on PATH

This happens when installing via pip — Node.js must be installed separately.

# macOS
brew install node

# macOS / Linux — via nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
nvm install 20

# Ubuntu / Debian
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

After installing Node.js, open a new terminal and retry.

/setup-project didn't generate anything Make sure you ran claudeforge init first — the .claude/commands/ directory must exist for slash commands to work.

Hook scripts not running

# Verify hooks are executable
ls -la .claude/hooks/
# Re-apply execute permission
chmod 755 .claude/hooks/*.sh
# Re-run init to restore hooks
claudeforge init --force

claudeforge upgrade overwrote my custom changes Only use --all flag when you want to reset user-owned files. Without --all, only infrastructure files (hooks, rules, built-in commands) are updated.

Slash commands not showing in IDE Confirm you're running Claude Code (not just Copilot Chat). The .claude/commands/ directory must be in the project root. Restart the IDE after running init.


License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

claudeforge-1.0.1.tar.gz (48.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

claudeforge-1.0.1-py3-none-any.whl (68.8 kB view details)

Uploaded Python 3

File details

Details for the file claudeforge-1.0.1.tar.gz.

File metadata

  • Download URL: claudeforge-1.0.1.tar.gz
  • Upload date:
  • Size: 48.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for claudeforge-1.0.1.tar.gz
Algorithm Hash digest
SHA256 ee466bb1da8f007df5691411bcd6d6f71394168c2f8acc0abb586cdd4b03b0ec
MD5 1d428e0637d287a8d483b9b0e5c38911
BLAKE2b-256 0139f11a0c942488b883cc8c947416eb14f2980cd9c42752775a49653bf6c0f0

See more details on using hashes here.

File details

Details for the file claudeforge-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: claudeforge-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 68.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for claudeforge-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7fce98e0951e7e9e93191b6653cf5bc86806c9f81a55d52078a50d55e1d31e9f
MD5 32e407ac7e902ce56bd7dbb815fb0f9f
BLAKE2b-256 2cf5130f842985b56298c03368fe749afdb845c037ca48f44149a9bec4d64d16

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page