Workspai CLI
One workspace. One truth. Humans and AI aligned.
Open-source workspace intelligence for software systems — create planner, model, proof-backed graph retrieval, context, agent-sync, impact analysis, verification evidence, and release gates.
npx workspai --helpnpx workspai my-workspace --yes --profile polyglotnpx workspai workspace intelligence run --for-agent generic --strict --jsonnpx workspai workspace graph search "authentication endpoint" --limit 12 --jsonnpx workspai workspace eval report --jsonCreate planner paths
Native create, official generator handoff, or existing project adoption — one command surface per stack
Next.js Frontend
npm-backedCreate official Next.js apps with RapidKit workspace metadata and contracts.
npx workspai create project nextjs web- Uses create-next-app@latest under the hood
- Writes RapidKit project metadata
- Participates in the model-derived Workspace Knowledge Graph
- Works from CLI and Workspai sidebar
Adopt Existing Project
in-placeLink a local repo into a workspace without moving or copying source.
cd /path/to/project && npx workspai adopt .- Detect runtime and command capabilities
- Create portable project grounding and a bounded context lens
- Keep the machine-local workspace binding out of version control
- Participate in model, graph, impact, Doctor, and verify
FastAPI Project
Core-backedCreate production-ready FastAPI projects with Core module workflows.
npx workspai create project fastapi.standard my-api- Core-backed project workflow
- Access the RapidKit module catalog
- Clean architecture out of the box
- Full CLI command support
NestJS Project
Core-backedCreate enterprise-ready NestJS projects with TypeScript module boundaries.
npx workspai create project nestjs.standard my-api- TypeScript-first development
- Modular architecture
- Enterprise patterns included
- Full CLI command support
Go Fiber / Gin Project
npm-backedCreate Go services with workspace contracts and runtime-aware commands.
npx workspai create project gofiber.standard my-api- Go module scaffold
- Fiber and Gin choices
- Workspace contract metadata
- Observed command capability mapping
Spring Boot Project
npm-backedCreate JVM services inside RapidKit workspaces.
npx workspai create project springboot.standard my-api- Java 21-oriented scaffold
- Health endpoint and project metadata
- Workspace run compatibility
- Project import parity with other runtimes
ASP.NET Core Project
previewCreate clean architecture .NET Web API projects.
npx workspai create project dotnet.webapi.clean my-api- .NET 8 Web API scaffold
- Application/domain/API boundaries
- Workspace contract participation
- Preview runtime support matrix
Rust / Axum Project
native previewCreate a Rust API from Workspai’s tested Axum baseline with Cargo-aware project evidence.
npx workspai create project rust.axum my-api- Preview native Axum scaffold from a tested baseline
- Backend project-kind classification
- Cargo-aware Doctor and command capabilities
- Model, graph, context, and grounding synchronized after create
Desktop or Extension Project
officialUse stable ecosystem generators for Tauri, Electron, or VS Code extensions.
npx workspai create project desktop.tauri my-desktop- Official generator owns its template
- Resolved generator and dependency versions are recorded
- Workspai owns registration and workspace evidence
- No Python engine setup unless the selected flow needs it
Laravel Project
officialCreate the stable Laravel application and register it into the workspace.
npx workspai create project php.laravel my-api- Stable Composer create-project handoff
- Laravel runtime and framework detection
- Configuration, migration, dependency, and test checks
- Model, graph, context, and grounding synchronized after create
Import Repository
observedClone or register a git URL into a governed RapidKit workspace.
npx workspai import ./repo.git- Detect runtime after checkout
- Add project to workspace metadata
- Participate in the model-derived Workspace Knowledge Graph
- Keep unsupported actions explicit
Powerful Features
Everything you need to start building
Governed Workspaces
Create, adopt, or import projects under one workspace boundary, then work from either the workspace or project directory.
- npx workspai my-workspace --yes --profile polyglot
- cd /path/to/project && npx workspai adopt .
- Portable AGENTS.md + bounded project context
- Machine-local workspace path stays gitignored
- Reports under .workspai/reports/
Runtime-aware Command Routing
Run one CLI across npm-owned kits, Python Core-backed projects, and observed imports.
- Native Workspai kits plus stable official ecosystem generators
- Core-backed FastAPI and NestJS workflows
- Adopt in-place or import git repos
- Capability-aware project command matrix
Unified Project Creation
Create, adopt, or import governed projects with one workspace-native command surface.
- cd /path/to/project && npx workspai adopt .
- npx workspai create project nextjs web
- npx workspai create project fastapi.standard
- npx workspai create project nestjs.standard
- npx workspai create project gofiber.standard
- npx workspai create project rust.axum
- npx workspai create project desktop.tauri
- npx workspai create project extension.vscode
- npx workspai create project php.laravel
- npx workspai import ./repo.git
- Interactive framework selection
Workspace Intelligence
Build shared understanding for developers, CI, IDEs, and AI agents.
- npx workspai workspace intelligence run --for-agent generic --strict --json
- Authoritative report: .workspai/reports/workspace-intelligence-run-last-run.json
- 11 contract-ordered stages
- Targeted stage commands remain available for inspection and recovery
Evidence-backed Knowledge Graph
Query a graph derived from the canonical Workspace Model, with every accepted build bound to its stable structural hash.
- npx workspai workspace graph search "authentication endpoint" --limit 12 --json
- Canonical artifact: .workspai/reports/workspace-knowledge-graph.json
- Consumers reject stale model identity, project topology, or hash mismatches
- Evidence lookup, proof paths, change overlays, and bounded retrieval
- Portable projections: JSON-LD · GraphML · GEXF · Mermaid · DOT · JSON
- MCP tool: searchWorkspaceGraph
Governed Evaluation
Record observed retrieval and model-usage evidence, then compare compatible runs without universal token-saving claims.
- npx workspai workspace eval status --json
- npx workspai workspace eval report --json
- npx workspai workspace eval compare baseline.json candidate.json --json
- Governed artifact: .workspai/reports/workspace-intelligence-evaluation-last-run.json
Graph-aware Doctor & Test Evidence
Diagnose projects with runtime checks, graph proofs, impact candidates, verification targets, and measurable coverage evidence.
- npx workspai doctor project
- npx workspai project coverage --run --target 80 --strict --json
- Structural paths never masquerade as proven runtime causality
- Doctor, CLI, CI, IDEs, and agents read the same governed evidence
Create Planner
Native create, official generator handoff, or existing project adoption — Workspai selects the matching path per stack.
- native — first-class kits (FastAPI, NestJS, Go, Spring, .NET, Axum)
- official — stable ecosystem generator + registration evidence
- existing — existing repos without scaffolding
- Tauri, Electron, VS Code Extension, Laravel, and frontend generators
Developer Experience
Built with TypeScript for reliability and performance.
- Interactive CLI prompts
- Debug mode available
- Dry-run preview
- Auto-update checks
Typical Workflow
Create shared understanding automatically, then create or adopt projects
| Step | Greenfield | Adopt | Import |
|---|---|---|---|
1 Create workspace | npx workspai my-workspace --yes --profile polyglot | cd /path/to/project && npx workspai adopt . | npx workspai import ./repo.git |
2 Review synchronized evidence | npx workspai workspace model --json --write | npx workspai doctor project | npx workspai workspace verify --json |
3 Run canonical intelligence chain | npx workspai workspace intelligence run --for-agent generic --strict --json | npx workspai workspace intelligence run --for-agent generic --strict --json | npx workspai workspace intelligence run --for-agent generic --strict --json |
4 Separate governance gate | npx workspai pipeline --json --strict --no-agent-sync | npx workspai pipeline --json --strict --no-agent-sync | npx workspai pipeline --json --strict --no-agent-sync |
After a Change
Diff → impact → verify → trace — the governance loop agents and CI can share
npx workspai workspace diff --from git --json --writenpx workspai workspace impact --from .workspai/reports/workspace-model-diff-last-run.json --json --writenpx workspai workspace verify --strict --json --writenpx workspai workspace trace --from .workspai/reports/workspace-model-diff-last-run.json --json --writeStart with workspace intelligence
Create or adopt a workspace, sync agents, then verify with shared evidence
npx workspai my-workspace --yes --profile polyglot