Documentation

Workspai docs

Everything you need to create, understand, and govern software workspaces from the CLI, CI, and VS Code.

Quick start

Install the CLI, create or adopt your first governed workspace, then open the same evidence in VS Code.

Install VS Code extension

Install the Workspai CLI

Run npm install -g workspai, or use npx workspai for an install-free first run.

Open npm

Create or adopt a workspace

Create a governed workspace, import a repository, or adopt an existing project without moving its source.

Add the VS Code extension

Install Workspai from the Marketplace, open the workspace, and use the same model, evidence, and repair paths inside your editor.

Open Marketplace

Workspai CLI

The open-source CLI owns the deterministic workspace layer. Bootstrap workspaces, adopt repositories, scaffold kits, produce evidence, and enforce release gates from the terminal or CI.

$npm install -g workspai

$npx workspai my-workspace --yes --profile polyglot

$npx workspai bootstrap --profile polyglot

$npx workspai create project nextjs my-web --yes

$npx workspai workspace model --json --write

$npx workspai workspace context --for-agent --json --write

$npx workspai workspace diff --from git --json --write

$npx workspai workspace impact --from .workspai/reports/workspace-model-diff-last-run.json --json --write

$npx workspai doctor workspace --json

$npx workspai workspace remediation-plan --ci --json --write

$npx workspai workspace verify --strict --json

$npx workspai workspace agent-sync --write --refresh-context --preset enterprise

Or run instantly with npx workspai …. Full CLI reference

Framework coverage

Workspace Intelligence is framework-agnostic. Existing projects can enter a Workspai workspace through import or adopt regardless of language or framework. The list below defines where Workspai can also create a new project from scratch.

Existing project

adopt / import

Any language or framework can join the workspace architecture without moving or regenerating its source. Workspai registers the project and includes it in workspace modeling, context, governance, and evidence workflows.

Examples: Laravel, Rails, Django, WordPress, Rust, PHP, Kotlin, legacy services, and mixed monorepos.

New project

create

Creating from zero requires a supported native or ecosystem create lane. These lanes own the generator handoff, project marker, workspace registration, and post-create contract.

Only the create lanes listed below are promised for new scaffolds today.

Create-from-scratch lanes

RapidKit Core supplies deeper Python-engine kits and backend modules where applicable.

FastAPI

Python 3.11+

fastapi.standardfastapi.ddd

NestJS

Node.js · TypeScript

nestjs.standard

Go / Fiber

Go 1.21+

gofiber.standard

Go / Gin

Go 1.21+

gogin.standard

Spring Boot

Java 17+

springboot.standard

ASP.NET Core

.NET 8+ · C#

dotnet.webapi.clean

Frontend Apps

Node.js · TypeScript

frontend.nextjsfrontend.remixfrontend.vite-reactfrontend.vite-vuefrontend.vite-sveltefrontend.vite-solidfrontend.vite-vanillafrontend.nuxtfrontend.angularfrontend.astrofrontend.sveltekit

Your framework is not listed? Adopt or import the existing project today. More create-from-scratch lanes are planned; see the changelog for updates.

Command reference

All commands are accessible from the VS Code command palette.

⌘⇧P/Ctrl+Shift+P→ type "Workspai:"

Workspace & Navigation

Workspai: Show Welcome

Open the main dashboard webview — project tree, health overview, module inventory, and Studio/Advisor entry points.

Workspai: Select Workspace

Switch the active workspace used by the dashboard, sidebar, Studio, and Advisor.

Workspai: Create Workspace

Create a workspace boundary before adding or importing projects.

Workspai: Create Project

Scaffold a supported kit through the Workspai CLI bridge.

Workspai: Import Project

Bring an existing local project into the active workspace for governance and evidence-backed context.

Workspai: Open Studio

Open the focused repair surface for card fixes, editor issues, and verification handoffs.

Workspai: Run System Check

Automated health check across workspace and projects. Flags missing env vars, broken deps, port conflicts, and kit config issues.

Workspai: Show Logs

Open the Workspai extension output channel to inspect debug and runtime logs.

Workspai: Show Telemetry Summary

Review local workflow outcomes and command evidence without exposing workspace source.

Studio & Advisor sessions

Fix with Workspai

Editor diagnostic action. Opens Studio with file, language, diagnostic, and selected-code evidence.

Explain with Workspai

Editor diagnostic action. Opens Advisor for explanation without applying changes.

Workspai: AI Fix Preview (Lite)

Produces candidate edits for review with No auto-apply behavior.

Workspai: AI Change Impact (Lite)

Summarizes risk level, affected scope, and recommended test targets before a change.

Workspai: AI Smart Route

Routes the current workspace question to the smallest suitable evidence-backed workflow.

Workspai: AI Essentials

Opens the shipped set of scoped AI actions and their review-first boundaries.

Workspai: Analyze Terminal Output with AI

Sends selected terminal output into a scoped diagnosis with evidence and verification guidance.

Workspai: Guided Workspace Memory Setup

Creates reviewable workspace grounding and memory policy for supported agent surfaces.

Workspai: AI Recipe Packs

Opens 11 reusable AI workflows for release readiness, debugging, architecture, and project operations.

Workspai: AI Workspace Command Center

Opens the consolidated AI workflow launcher for the active workspace.

Fix by Workspai

Artifact-card action. Opens a Studio repair session backed by Workspai remediation-plan evidence.

Send to Advisor

Ask about a workspace, project, artifact, or command without leaving the selected scope.

Refresh evidence

Run the relevant Workspai command and reload the card/session from the latest artifact.

Verify after fix

Run the scoped verify command before a card is allowed to look resolved.

Chat Participant

@workspai /ask [question]

Context-aware architecture Q&A grounded in your workspace files, modules, and project structure — not generic LLM answers.

@workspai /debug [error]

Structured Root Cause → Remediation → Prevention flow. Uses your live VS Code editor diagnostics as context.

Studio / Advisor workflows

Studio fixes issues from artifact cards and editor diagnostics. Advisor explains scope and architecture. For Cursor, Claude, Codex, and CI, run workspace agent-sync --write from the Workspai CLI — same workspace evidence, every tool.

Guided Create

"Create workspace billing-platform-wsp, then add FastAPI API + Next.js web"

Project Assistant

"What breaks if I change this settings model?"

Workspace Advisor

"Explain the auth module and its dependencies"

@workspai in Chat

"@workspai /debug Why does this return 500?"

Editor Issue Actions

"Fix with Workspai for this TypeScript diagnostic"

Fix by Workspai

"Open Studio from the blocked Readiness card"

Explain with Workspai

"Explain this import error without applying changes"

Change Impact

"If I change this auth middleware, what breaks?"

Terminal Evidence Review

"Analyze this pytest failure and suggest the verify command"

Agent Context Pack

"Refresh workspace context for agents"

Agent Sync

"Sync AGENTS.md, Copilot, Cursor, Claude, and skills surfaces"

Workspace Playbooks

"Use the release-readiness playbook for this workspace"

Module Advisor

"How do I wire db_postgres with auth_core?"

Command Evidence History

"Show recent doctor, analyze, readiness, and verify outputs"

Wave 2 claim policy

We do not label a capability as stable or retention-driving until it has scope evidence, verification path, telemetry outcomes, and release-gate compliance.

✓Stable requires repeatable behavior and passing release gates.
✓Useful requires clear time-to-value in the Workspai Studio loop.
✓Retention-driving requires production telemetry, not demo-only evidence.

Next practical step

Try Workspai in a real workspace workflow

Install the extension, create your first project, then compare platform capabilities and pricing when your team is ready to scale.

Install from VS Code Marketplace CLI reference

Need plan details? Compare tiers or browse workspace examples.