Skip to main content

RaiSE CLI - Reliable AI Software Engineering governance framework

Project description

RaiSE

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+
  • uv (recommended) or pip
  • Claude Code CLI installed and configured

Quick Install (from PyPI)

pip install rai-cli

# Or with uv:
uv pip install rai-cli

# Verify
rai --help

Development Setup

# 1. Clone and checkout the development branch
git clone https://gitlab.com/humansys-demos/product/raise1/raise-commons.git
cd raise-commons
git checkout v2

# 2. Install in development mode
uv pip install -e ".[dev]"

If error "No virtual environment found."
run `uv venv` to create an environment.

# 3. Verify installation
rai --help

Windows WSL (Ubuntu/Debian).

# 1 — Use pipx

sudo apt update
sudo apt install pipx -y
pipx ensurepath


# 2 Close and new terminal WSL.

# 3 Install:

pipx install rai-cli

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

# 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.

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

Epic Lifecycle

Skill Purpose
/rai-epic-start Initialize an epic with branch
/rai-epic-design Design multi-story epics
/rai-epic-plan Sequence stories into plans
/rai-epic-close Epic retrospective and merge

Discovery Skills

Skill Purpose
/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-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

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

CLI Commands

The rai CLI provides deterministic operations:

# 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 (27 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/rai_cli/         # CLI toolkit (Python)
│
├── work/                # Work in progress
│   └── stories/         #   Story artifacts (scope, design, plan, retro)
│
└── dev/                 # Framework maintenance
    ├── decisions/       #   ADRs (Architecture Decision Records)
    └── parking-lot.md   #   Ideas and tangents for later

Branch Model

main (stable releases)
  └── v2 (development)
        └── epic/e{N}/{name}
              └── story/s{N}.{M}/{name}
  • Work on v2 (development branch)
  • Stories branch from and merge back to their epic or v2
  • main receives releases from v2

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 for canonical terminology.


Key Principles

From the Constitution:

  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.1.0. The framework is being used in production.

We value your feedback:

  • Questions? Open an issue
  • Found a bug? Open an issue with reproduction steps
  • Ideas? We want to hear them — open an issue or reach out directly

License

Apache-2.0


RaiSE — Reliable AI Software Engineering Neither is complete alone.

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

rai_cli-2.1.0.tar.gz (272.9 kB view details)

Uploaded Source

Built Distribution

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

rai_cli-2.1.0-py3-none-any.whl (375.4 kB view details)

Uploaded Python 3

File details

Details for the file rai_cli-2.1.0.tar.gz.

File metadata

  • Download URL: rai_cli-2.1.0.tar.gz
  • Upload date:
  • Size: 272.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rai_cli-2.1.0.tar.gz
Algorithm Hash digest
SHA256 62fcfe1ed7b5f36cb14ba24d1d2837450a74d7d414e3a229812d8028e710abcf
MD5 4222dc35ce9e97cded99730094f72037
BLAKE2b-256 103ccc365aa01f8878be03e03f7b52386b98ee02f6a46e2f12f2e5544eb13c83

See more details on using hashes here.

Provenance

The following attestation bundles were made for rai_cli-2.1.0.tar.gz:

Publisher: release.yml on humansys/raise

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rai_cli-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: rai_cli-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 375.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rai_cli-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 99709d0b2210c0f037ef50afefb5b1c1f9c6898ac24b955d404a74abf4717eff
MD5 5c3ae3ef8db7fa02c8d53ab92b49b743
BLAKE2b-256 74b475f409f90f642fd02210fa09dfa2a241ca7e258d463173a3c6d46d930be3

See more details on using hashes here.

Provenance

The following attestation bundles were made for rai_cli-2.1.0-py3-none-any.whl:

Publisher: release.yml on humansys/raise

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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