raise-cli 2.2.1__py3-none-any.whl

raise_cli-2.2.1.dist-info/METADATA

@@ -0,0 +1,433 @@
+Metadata-Version: 2.4
+Name: raise-cli
+Version: 2.2.1
+Summary: RaiSE CLI - Reliable AI Software Engineering governance framework
+Project-URL: Homepage, https://raiseframework.ai
+Project-URL: Documentation, https://docs.raiseframework.ai
+Project-URL: Repository, https://github.com/humansys/raise
+Project-URL: Changelog, https://github.com/humansys/raise/blob/main/CHANGELOG.md
+Author-email: Emilio Osorio <emilio@humansys.ai>
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: ai,cli,governance,methodology,software-engineering
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.12
+Requires-Dist: atlassian-python-api>=3.41.0
+Requires-Dist: authlib>=1.3.0
+Requires-Dist: certifi>=2024.7.4
+Requires-Dist: cryptography>=46.0.5
+Requires-Dist: logfire-api>=4.0
+Requires-Dist: networkx>=3.6.1
+Requires-Dist: pydantic-settings>=2.2.0
+Requires-Dist: pydantic>=2.6.0
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: raise-core==2.2.1
+Requires-Dist: requests>=2.32.4
+Requires-Dist: rich>=13.7.0
+Requires-Dist: tree-sitter-javascript>=0.25.0
+Requires-Dist: tree-sitter-language-pack>=0.13.0
+Requires-Dist: tree-sitter-php>=0.24.1
+Requires-Dist: tree-sitter-svelte>=1.0.2
+Requires-Dist: tree-sitter-typescript>=0.23.2
+Requires-Dist: tree-sitter>=0.25.2
+Requires-Dist: typer>=0.12.0
+Requires-Dist: urllib3>=2.6.3
+Provides-Extra: csharp
+Requires-Dist: tree-sitter-c-sharp>=0.23.1; extra == 'csharp'
+Provides-Extra: dev
+Requires-Dist: bandit>=1.7.8; extra == 'dev'
+Requires-Dist: httpx>=0.27.0; extra == 'dev'
+Requires-Dist: pyright>=1.1.350; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: raise-server; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Provides-Extra: mcp
+Requires-Dist: mcp<2,>=1.26; extra == 'mcp'
+Provides-Extra: observability
+Requires-Dist: logfire>=4.0; extra == 'observability'
+Description-Content-Type: text/markdown
+
+# RaiSE
+
+[![CI](https://github.com/humansys/raise/actions/workflows/ci.yml/badge.svg)](https://github.com/humansys/raise/actions/workflows/ci.yml)
+
+**Reliable AI Software Engineering** — Ship quality software at AI speed.
+
+> *Raise your craft, feature by feature.*
+
+---
+
+## What is RaiSE?
+
+RaiSE is a methodology + toolkit for professional developers who use AI assistants. It solves the problem of AI-generated code that's fast but inconsistent: governance that works naturally, validation at every step, and memory that persists across sessions.
+
+**The RaiSE Triad:**
+
+```
+        RaiSE Engineer
+        (You - Strategy, Judgment, Ownership)
+              │
+              │ collaborates with
+              ▼
+           Rai
+   (AI Partner - Execution + Memory)
+              │
+              │ governed by
+              ▼
+           RaiSE
+    (Methodology + Toolkit)
+```
+
+**Rai** is your AI collaborator — not a generic assistant, but a partner trained in the discipline of reliable AI software engineering. Rai remembers your patterns, calibrates to your velocity, and maintains coherence across sessions.
+
+---
+
+## Developer Onboarding
+
+### Prerequisites
+
+- **Python 3.12 or 3.13** (3.14 not yet supported)
+- [Claude Code](https://claude.ai/claude-code) CLI installed and configured
+- Git
+
+### Quick Install
+
+```bash
+# Recommended: pipx (isolates dependencies)
+pipx install raise-cli
+
+# Alternative: pip (use a virtual environment)
+pip install raise-cli
+
+# Alternative: uv
+uv tool install raise-cli
+
+# Verify
+rai --version
+```
+
+**macOS:** Don't use the system Python. Install Python 3.12+ via `brew install python@3.13` or pyenv first.
+
+**Windows:** Use WSL (Ubuntu/Debian):
+```bash
+sudo apt update && sudo apt install pipx -y
+pipx ensurepath
+# Close and reopen terminal
+pipx install raise-cli
+```
+
+### Development Setup
+
+```bash
+# 1. Clone and checkout the development branch
+git clone https://github.com/humansys/raise.git
+cd raise-commons
+git checkout dev
+
+# 2. Create venv and install in development mode
+uv venv && uv pip install -e ".[dev]"
+
+# 3. Verify installation
+rai --help
+```
+
+### Onboarding with Rai
+
+Once installed, open Claude Code in the project directory and run:
+
+```
+/rai-welcome
+```
+
+This single command will:
+- **Detect your situation** (new developer, returning developer, etc.)
+- **Create your profile** (`~/.rai/developer.yaml`) with your name and pattern prefix
+- **Build the knowledge graph** so Rai has project context
+- **Scaffold `CLAUDE.local.md`** for your personal Claude Code instructions
+- **Optionally customize** communication preferences (language, style)
+- **Verify everything works**
+
+After welcome completes, start working:
+
+```
+/rai-session-start
+```
+
+This loads your context, memory, and proposes focused work.
+
+### What You Get
+
+| Shared (committed) | Personal (gitignored) |
+|--------------------|-----------------------|
+| Patterns (`.raise/rai/memory/patterns.jsonl`) | Session history (`.raise/rai/personal/sessions/`) |
+| Governance docs | Session state (`.raise/rai/personal/session-state.yaml`) |
+| Skills, methodology | Calibration data (`.raise/rai/personal/calibration.jsonl`) |
+| Work artifacts | Knowledge graph (`.raise/rai/memory/index.json`) |
+
+Each developer builds their own personal context through working sessions. Pattern IDs are developer-prefixed (e.g., PAT-A-001 for Alice, PAT-B-001 for Bob) to prevent collisions in shared repositories.
+
+---
+
+## Usage
+
+### Initialize RaiSE on Your Project
+
+```bash
+# Navigate to your existing project
+cd your-project
+
+# Initialize RaiSE governance structure
+rai init --detect
+
+# Open Claude Code and run onboarding
+/rai-welcome
+```
+
+This scaffolds the `.raise/` directory, detects your project's conventions (language, testing framework, linting), and builds the knowledge graph.
+
+### Daily Workflow
+
+A typical session follows this pattern:
+
+```
+1. /rai-session-start          # Load context, see what's pending
+2. /rai-story-start             # Create branch, define scope
+3. /rai-story-design            # Design the approach (recommended)
+4. /rai-story-plan              # Break into atomic tasks
+5. /rai-story-implement         # TDD execution with validation gates
+6. /rai-story-review            # Retrospective, capture patterns
+7. /rai-story-close             # Merge, cleanup
+8. /rai-session-close           # Persist learnings for next session
+```
+
+You don't need to complete all steps in one session — Rai remembers where you left off.
+
+### What Rai Remembers
+
+- **Patterns** — Reusable insights learned from your work (e.g., "always validate config at boundaries")
+- **Calibration** — Your velocity, strengths, growth edges
+- **Session history** — What you worked on, decisions made, items deferred
+- **Coaching corrections** — Mistakes Rai made and learned from
+
+Each session builds on the last. Over time, Rai becomes a more effective collaborator for your specific codebase and working style.
+
+---
+
+## Available Skills
+
+Skills are structured processes that guide AI-assisted development. Run them as `/skill-name` in Claude Code. There are currently 37 skills.
+
+### Session Lifecycle
+| Skill | Purpose |
+|-------|---------|
+| `/rai-welcome` | One-time developer onboarding |
+| `/rai-session-start` | Begin a session with memory and context |
+| `/rai-session-close` | End a session, persist learnings |
+
+### Story Lifecycle
+| Skill | Purpose |
+|-------|---------|
+| `/rai-story-start` | Initialize a story with branch and scope |
+| `/rai-story-design` | Create lean specs for complex stories |
+| `/rai-story-plan` | Decompose into atomic tasks |
+| `/rai-story-implement` | Execute with TDD and validation gates |
+| `/rai-story-review` | Retrospective and learnings |
+| `/rai-story-close` | Merge, cleanup, tracking |
+| `/rai-story-run` | Chain the full story lifecycle |
+
+### Epic Lifecycle
+| Skill | Purpose |
+|-------|---------|
+| `/rai-epic-start` | Initialize an epic scope and directory |
+| `/rai-epic-design` | Design multi-story epics |
+| `/rai-epic-plan` | Sequence stories into plans |
+| `/rai-epic-close` | Epic retrospective and metrics |
+| `/rai-epic-run` | Execute epic lifecycle phases |
+
+### Discovery Skills
+| Skill | Purpose |
+|-------|---------|
+| `/rai-discover` | Run the full discovery pipeline |
+| `/rai-discover-start` | Initialize codebase discovery |
+| `/rai-discover-scan` | Extract and describe components |
+| `/rai-discover-validate` | Validate synthesized descriptions with human review |
+| `/rai-discover-document` | Generate architecture docs from discovery data |
+
+### Project Skills
+| Skill | Purpose |
+|-------|---------|
+| `/rai-welcome` | One-time developer onboarding |
+| `/rai-project-create` | Guide greenfield project setup |
+| `/rai-project-onboard` | Guide brownfield project onboarding |
+
+### Analysis & Quality
+| Skill | Purpose |
+|-------|---------|
+| `/rai-research` | Epistemologically rigorous research |
+| `/rai-debug` | Root cause analysis (5 Whys, Ishikawa) |
+| `/rai-bugfix` | Structured bugfix workflow |
+| `/rai-quality-review` | Critical code review with external auditor perspective |
+| `/rai-architecture-review` | Evaluate design proportionality and necessity |
+| `/rai-problem-shape` | Guided problem definition at portfolio level |
+| `/rai-doctor` | Diagnose and fix RaiSE project health issues |
+
+### MCP Integration
+| Skill | Purpose |
+|-------|---------|
+| `/rai-mcp-add` | Add an MCP server to the project |
+| `/rai-mcp-remove` | Remove an MCP server from the project |
+| `/rai-mcp-status` | Check MCP server health and status |
+
+### Maintenance
+| Skill | Purpose |
+|-------|---------|
+| `/rai-docs-update` | Sync architecture docs with code |
+| `/rai-framework-sync` | Sync framework files across locations |
+| `/rai-publish` | Structured release workflow with quality gates |
+| `/rai-skill-create` | Create new skills with framework integration |
+| `/rai-skillset-manage` | Manage skill sets |
+
+---
+
+## CLI Commands
+
+The `rai` CLI provides deterministic operations:
+
+```bash
+# Build Rai's knowledge graph from project artifacts
+rai graph build
+
+# Query governance concepts
+rai graph context mod-session
+
+# Query Rai's memory
+rai graph query "velocity patterns"
+
+# Validate the memory graph (structural + completeness)
+rai graph validate
+
+# Visualize the memory graph as interactive HTML
+rai graph viz                    # Opens in browser
+rai graph viz --output graph.html  # Custom output path
+
+# List releases and their associated epics
+rai release list
+
+# Start a session (creates profile on first run)
+rai session start --name "YourName" --project "$(pwd)" --context
+
+# Close a session
+rai session close --state-file /tmp/session-output.yaml --project "$(pwd)"
+```
+
+---
+
+## Repository Structure
+
+```
+raise-commons/
+├── .claude/skills/      # Claude Code skills (37 skills)
+│
+├── framework/           # Public textbook (concepts, reference)
+│   ├── reference/       #   Constitution, glossary, philosophy
+│   ├── concepts/        #   Core concepts (katas, gates, artifacts)
+│   └── getting-started/ #   Greenfield/brownfield guides
+│
+├── .raise/              # Framework engine
+│   ├── rai/             #   Rai's memory and personal data
+│   │   ├── memory/      #     Patterns, knowledge graph (shared)
+│   │   └── personal/    #     Sessions, calibration (per-developer, gitignored)
+│   ├── katas/           #   Process definitions
+│   ├── gates/           #   Validation criteria
+│   ├── templates/       #   Artifact scaffolds
+│   └── skills/          #   Legacy skill definitions
+│
+├── governance/          # Project governance
+│   ├── architecture/    #   Module docs, system design
+│   └── solution/        #   Vision, guardrails, business case
+│
+├── src/raise_cli/         # CLI toolkit (Python)
+│
+├── work/                # Work in progress
+│   └── epics/           #   Epic directories containing story artifacts
+│
+└── dev/                 # Framework maintenance
+    ├── decisions/       #   ADRs (Architecture Decision Records)
+    └── parking-lot.md   #   Ideas and tangents for later
+```
+
+---
+
+## Branch Model
+
+```
+main (stable releases)
+  └── dev (development)
+        └── story/s{N}.{M}/{name}
+```
+
+- Work on `dev` (development branch)
+- Stories branch from and merge to `dev`
+- Epics are logical containers (directory + tracker), not branches
+- `main` receives releases from `dev`
+
+---
+
+## Core Concepts
+
+| Concept | Description |
+|---------|-------------|
+| **RaiSE Engineer** | You — the human who directs AI-assisted development |
+| **Rai** | AI partner with memory, calibration, and accumulated judgment |
+| **Skill** | Structured Claude Code prompt for a methodology phase |
+| **Validation Gate** | Quality checkpoint with specific criteria |
+| **Guardrail** | Constraint that guides AI behavior |
+| **ShuHaRi** | Mastery levels (beginner → practitioner → master) that adapt Rai's verbosity |
+
+See the full [Glossary](framework/reference/glossary.md) for canonical terminology.
+
+---
+
+## Key Principles
+
+From the [Constitution](framework/reference/constitution.md):
+
+1. **Humans Define, Machines Execute** — Specs are source of truth
+2. **Governance as Code** — Standards versioned in Git
+3. **Validation Gates** — Quality checked at each phase
+4. **Observable Workflow** — Every decision traceable
+5. **Jidoka** — Stop on defects, don't accumulate errors
+
+---
+
+## Status
+
+Current stable release: `v2.2.0`. The framework is being used in production.
+
+For CLI reference documentation, see the [CLI Quick Reference](framework/reference/cli-reference.md).
+
+We value your feedback:
+
+- **Questions?** Open an [issue](https://github.com/humansys/raise/issues)
+- **Found a bug?** Open an [issue](https://github.com/humansys/raise/issues) with reproduction steps
+- **Ideas?** We want to hear them — open an issue or reach out directly
+
+---
+
+## License
+
+[Apache-2.0](LICENSE)
+
+---
+
+*RaiSE — Reliable AI Software Engineering*
+*Neither is complete alone.*