Skip to main content

Bootstrap Claude Code knowledge architecture (CLAUDE.md, STANDARDS.md, QUICKSTART.md, ERRORS_AND_LESSONS.md)

Project description

Super-Claude

Bootstrap Claude Code knowledge architecture in any project directory.

Generates context-aware CLAUDE.md, STANDARDS.md, QUICKSTART.md, and ERRORS_AND_LESSONS.md files that help Claude Code understand your codebase.

Install & Run

# No install needed — run directly:
pipx run superclaudeai

# Or with uv:
uvx superclaudeai

# Or install globally:
pip install superclaudeai
super-claude

Usage

super-claude                        # interactive setup in current directory
super-claude /path/to/project       # specific directory
super-claude --dry-run              # preview without writing
super-claude --force                # overwrite changed files (skip unchanged)
super-claude --force-all            # overwrite all files unconditionally
super-claude --yes                  # non-interactive (accept defaults)
super-claude --plan-json            # output project analysis as JSON
super-claude --with-readme          # also generate README.md
super-claude --with-ralph           # generate Ralph integration files
super-claude --reconfigure          # re-run wizard (ignore saved config)
super-claude --no-git-check         # skip git safety entirely
super-claude --git-mode stash       # auto-stash dirty changes
super-claude --git-mode skip        # skip git safety

Flags can be combined for full automation:

super-claude --force --yes          # overwrite changed files, no prompts
super-claude --force-all --yes      # overwrite ALL files, no prompts
super-claude --git-mode skip --yes  # full automation, no git checks

What It Does

  1. Scans your project — detects language, framework, deploy targets, monorepo structure
  2. Classifies project tier (T1-T4) based on blast radius
  3. Extracts from existing documentation if present
  4. Generates four files with context-aware content:
    • CLAUDE.md — project map, invariants, decision heuristics, verification standards
    • STANDARDS.md — governance rules, code quality gates, naming conventions
    • QUICKSTART.md — essential commands and quick fixes
    • ERRORS_AND_LESSONS.md — mistake catalog with rationalization table
  5. Verifies generated files have correct structure
  6. Saves wizard answers to .claude-setup.rc for future runs

Ralph Integration

The --with-ralph flag creates an integration layer that eliminates duplication between Ralph (an autonomous coding agent) and the Super-Claude knowledge architecture. Instead of maintaining separate context files, Ralph reads directly from the same generated documents, with a thin prompt wrapper and symlinks to keep everything in sync.

Files created by --with-ralph:

  • .ralph/PROMPT.md — Ralph-specific development instructions referencing the knowledge architecture
  • .ralph/AGENT.md — symlink to QUICKSTART.md (single source of truth)
  • .ralph/fix_plan.md — prioritized task list (Ralph-owned, never overwritten without --force)
  • .ralph/hooks/post-loop.sh — post-loop hook that detects changes to knowledge files
  • .ralphrc — stack-aware Ralph project configuration at the project root

Generated Content Highlights

  • Iron Laws — bright-line rules that are never violated
  • Decision Heuristics — 6 concrete rules for autonomous decision-making
  • Stuck Protocol — explicit steps when 3+ approaches fail
  • Red Flags — self-monitoring triggers to prevent common mistakes
  • Rationalization Table — excuse-to-reality mapping to catch bad reasoning
  • HARD-GATE tags — absolute non-negotiable rules
  • Tier-based governance — process weight proportional to blast radius
  • Defense-in-Depth debugging — 4-layer validation after bug fixes
  • Git worktree guidance — parallel development patterns (for git repos)
  • AUTO-MAINTAINED marker — QUICKSTART.md flagged for automatic upkeep
  • Idempotent regeneration--force skips unchanged files

Supported Stacks

Python, Node.js/TypeScript, Rust, Go, Ruby, Java/Kotlin, PHP, .NET, Elixir, Swift, Dart/Flutter, Zig, Scala

Supported Frameworks

Django, Flask, FastAPI, Next.js, React, Vue, Svelte, SvelteKit, Remix, Astro, Express, NestJS, Hono, Axum, Actix, Rocket, Gin, Fiber, Echo, Phoenix, Spring, Laravel, Flutter, and more.

Authors

  • Ronaldo Lima
  • Breno Lima

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

superclaudeai-1.3.0.tar.gz (34.7 kB view details)

Uploaded Source

Built Distribution

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

superclaudeai-1.3.0-py3-none-any.whl (35.9 kB view details)

Uploaded Python 3

File details

Details for the file superclaudeai-1.3.0.tar.gz.

File metadata

  • Download URL: superclaudeai-1.3.0.tar.gz
  • Upload date:
  • Size: 34.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for superclaudeai-1.3.0.tar.gz
Algorithm Hash digest
SHA256 14d9f0c1a53f6e1a6011d353e11419fa75409e48eb5c4c0133388bbb8635f3fc
MD5 d2985f069950e25e9950f210fe31e81b
BLAKE2b-256 ad0c87914b91f545eb9056e93b60da0ace157f480bdd2e2bf128d67fdf870a08

See more details on using hashes here.

File details

Details for the file superclaudeai-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: superclaudeai-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 35.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for superclaudeai-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 db8de0a3080997a0fe740bab98c4e090c54c1f643b1c96b3646667fc08c59233
MD5 a16d9b9dcdefc0644da150841841d11a
BLAKE2b-256 066a00b5b5e7ef87092fe40a4b9887b738d6f5fd0491229d784c57eb6bc49c0e

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