diff --git a/CLAUDE.md b/CLAUDE.md index 0b3ef8f..90ca56a 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -18,20 +18,19 @@ uv run python script.py # Execute scripts ## π Project Structure -**Dual-language architecture**: TypeScript plugins for Claude Code integration + Python package for testing/CLI tools. +> **β οΈ IMPORTANT**: The `.claude-plugin/` directory and TypeScript plugin system described in older docs **DO NOT EXIST** in v4.1.6. +> This is planned for v5.0 (see [issue #419](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues/419)). + +**Current v4.1.6 Architecture**: Python package with slash commands ``` -# TypeScript Plugins (project root) -pm/ # PM Agent: confidence checks, orchestration -research/ # Deep Research: web search, adaptive planning -index/ # Repository indexing: 94% token reduction -hooks/hooks.json # SessionStart auto-activation config - -# Claude Code Configuration -.claude/settings.json # Marketplace and plugin settings -.claude-plugin/ # Plugin manifest -βββ plugin.json # Plugin metadata (3 commands: /pm, /research, /index-repo) -βββ tests/ # Plugin tests +# Claude Code Configuration (v4.1.6) +.claude/ +βββ settings.json # User settings +βββ commands/ # Slash commands (installed via `superclaude install`) + βββ pm.md + βββ research.md + βββ index-repo.md # Python Package src/superclaude/ # Pytest plugin + CLI tools @@ -40,11 +39,13 @@ src/superclaude/ # Pytest plugin + CLI tools βββ execution/ # parallel.py, reflection.py, self_correction.py βββ cli/ # main.py, doctor.py, install_skill.py -# Command Definitions -commands/ # Plugin command markdown files -βββ pm.md # PM Agent command definition -βββ research.md # Research command definition -βββ index-repo.md # Index command definition +# Plugin Development (planned for v5.0 - see docs/plugin-reorg.md) +plugins/superclaude/ # Future plugin source (NOT ACTIVE) +βββ agents/ # Agent definitions +βββ commands/ # Command definitions +βββ hooks/ # Hook configurations +βββ scripts/ # Shell scripts +βββ skills/ # Skill implementations # Project Files tests/ # Python test suite @@ -119,20 +120,21 @@ Registered via `pyproject.toml` entry point, automatically available after insta - Automatic dependency analysis - Example: [Read files in parallel] β Analyze β [Edit files in parallel] -### TypeScript Plugins (v2.0) +### TypeScript Plugins (Planned for v5.0) -**Location**: Plugin source lives under `plugins/superclaude/` with unified assets (agents, commands, hooks, skills). -**Packaging**: `make build-plugin` renders `.claude-plugin/*` manifests into `dist/plugins/superclaude/`. +> **β οΈ NOT IMPLEMENTED**: The TypeScript plugin system described below does not exist in v4.1.6. +> This is planned for v5.0. See [issue #419](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues/419) and `docs/plugin-reorg.md`. -**Distributed commands**: -- **/sc:agent**: Session orchestrator, auto-starts via hooks -- **/sc:index-repo**: Repository indexing + PROJECT_INDEX generation -- **/sc:research**: Deep research workflow with Tavily + Context7 integration +**Current v4.1.6 Commands** (slash commands, not plugins): +- Install via: `pipx install superclaude && superclaude install` +- Commands installed to: `~/.claude/commands/` +- Available commands: `/pm`, `/research`, `/index-repo` (and others) -**Editing flow**: -- Update agents/commands/hooks/skills in `plugins/superclaude/*` -- Run `make build-plugin` locally to verify packaging -- Optionally `make sync-plugin-repo` to push artefacts into `../SuperClaude_Plugin` +**Planned Plugin Architecture** (v5.0 - NOT YET AVAILABLE): +- Plugin source will live under `plugins/superclaude/` +- `make build-plugin` will render `.claude-plugin/*` manifests +- Project-local detection via `.claude-plugin/plugin.json` +- Marketplace distribution support ## π§ͺ Testing with PM Agent @@ -244,49 +246,53 @@ Integrates with multiple MCP servers via **airis-mcp-gateway**. **Usage**: TypeScript plugins and Python pytest plugin can call MCP servers. Always prefer MCP tools over speculation for documentation/research. -## π Plugin Development +## π Development & Installation -### Project-Local Plugin Detection - -This project uses **project-local plugin detection** (v2.0): -- `.claude-plugin/plugin.json` is auto-detected when you start Claude Code in this directory -- No global installation needed for development -- PM Agent auto-activates via SessionStart hook - -### Plugin Architecture - -``` -Plugin Components: -1. Manifest templates (`plugins/superclaude/manifest/*.template.json`) -2. Command/agent assets (`plugins/superclaude/{commands,agents}/`) -3. Skills (`plugins/superclaude/skills/`) -4. Hooks & scripts (`plugins/superclaude/{hooks,scripts}/`) -``` - -### Development Workflow +### Current Installation Method (v4.1.6) +**Standard Installation**: ```bash -# 1. Edit plugin source -vim plugins/superclaude/commands/agent.md -vim plugins/superclaude/skills/confidence-check/confidence.ts +# Option 1: pipx (recommended) +pipx install superclaude +superclaude install -# 2. Run packaging + smoke tests -make build-plugin - -# 3. (optional) Sync generated artefacts into ../SuperClaude_Plugin -make sync-plugin-repo +# Option 2: Direct from repo +git clone https://github.com/SuperClaude-Org/SuperClaude_Framework.git +cd SuperClaude_Framework +./install.sh ``` -### Global vs Project-Local +**Development Mode**: +```bash +# Install in editable mode +make dev -**Project-Local**: -- Work directly from `plugins/superclaude/` -- Use `make build-plugin` for validation / artefact refresh -- Launch Claude Code inside this repo to exercise commands hot-loaded from disk +# Run tests +make test -**Distributed Package** (`../SuperClaude_Plugin`): -- Generated output committed for marketplace distribution -- Do not edit manuallyβregenerate via `make sync-plugin-repo` +# Verify installation +make verify +``` + +### Plugin System (Planned for v5.0 - NOT AVAILABLE) + +> **β οΈ IMPORTANT**: The plugin system described in older documentation **does not exist** in v4.1.6. +> These features are planned for v5.0 (see [issue #419](https://github.com/SuperClaude-Org/SuperClaude_Framework/issues/419)). + +**What Does NOT Work** (yet): +- β `.claude-plugin/` directory auto-detection +- β `/plugin marketplace add` commands +- β `/plugin install superclaude` +- β `make build-plugin` (planned but not functional) +- β Project-local plugin detection + +**Future Plans** (v5.0): +- Plugin marketplace distribution +- TypeScript-based plugin architecture +- Auto-detection via `.claude-plugin/plugin.json` +- Build workflow via `make build-plugin` + +See `docs/plugin-reorg.md` and `docs/next-refactor-plan.md` for implementation plans. ## π Package Information diff --git a/README-ja.md b/README-ja.md index 9a268f5..d787595 100644 --- a/README-ja.md +++ b/README-ja.md @@ -5,7 +5,7 @@ ### **Claude Codeγζ§ι ειηΊγγ©γγγγ©γΌγ γ«ε€ζ**
-
+
-
+
-
+
| -### π₯ **TypeScript Plugins** -**3 core plugins** with hot reload: -- **PM Agent**: Confidence-driven orchestration (β₯90% threshold) -- **Research**: Deep web search with adaptive planning -- **Index**: 94% token reduction (58K β 3K) -- Auto-activation via SessionStart hook -- Edit β Save β Instant reflection (no restart) +### β‘ **Optimized Performance** +**Smaller framework, bigger projects:** +- Reduced framework footprint +- More context for your code +- Longer conversations possible +- Complex operations enabled | ||
| -### β‘ **Optimized Performance** -**Smaller framework, bigger projects:** -- Reduced framework footprint -- More context for your code -- Longer conversations possible -- Complex operations enabled - - | -- ### π **Documentation Overhaul** **Complete rewrite** for developers: - Real examples & use cases @@ -349,6 +293,16 @@ uv run pytest - Practical workflows included - Better navigation structure + | ++ +### π§ͺ **Enhanced Stability** +**Focus on reliability:** +- Bug fixes for core commands +- Improved test coverage +- More robust error handling +- CI/CD pipeline improvements + |