One workspace. One truth. Humans and AI aligned.
Software is more than a folder of source files. It includes projects, services, APIs, dependencies, infrastructure, documentation, tests, policies, and release evidence.
Workspai brings those scattered parts together, so people and AI tools can understand and work with the same software system:
- See the whole workspace: understand what exists and how it fits together.
- Ask with proof: trace answers back to the files and facts that support them.
- Change with confidence: see impact, run the right checks, and give AI tools focused context.
Get started · How it works · Documentation · VS Code extension
You do not need to move an existing project. Open its directory and adopt it:
cd /absolute/path/to/project
npx workspai adopt .Workspai creates or reuses a minimal workspace in the default system location and links the project to it. You can stay in the project directory:
npx workspai workspace intelligence run --for-agent generic --strict --jsonThis run builds the current system view, checks its evidence, and prepares
shared context for people and tools. Results are saved under .workspai/.
When something is missing or blocked, Workspai reports it instead of claiming
the workspace is healthy.
Starting from scratch? Use the guided flow:
npx workspai createIt can create a workspace, scaffold a project, or add existing software.
| Question | Answer from Workspai |
|---|---|
| What is in this system? | A canonical model of projects, runtimes, frameworks, rules, and current evidence |
| How is it connected? | A searchable graph whose relationships link back to proof |
| What changed? | Saved snapshots, differences, and affected projects |
| Is it healthy or ready? | Doctor, analysis, policy, readiness, and verification results |
| What should an AI tool read? | Bounded context, instructions, skills, and MCP-accessible evidence |
| Why is something blocked? | A diagnosis, supporting evidence, and the next verification target |
The evidence index at .workspai/reports/INDEX.json is the simplest entry point
for developers, IDEs, CI, and agents.
Code · APIs · packages · infrastructure · docs · CI · policies
│
▼
Canonical Workspace Model
│
▼
Evidence-backed Knowledge Graph
│
▼
impact · doctor · verify · context · explain
│
▼
Developers · CI · IDEs · MCP · AI agents
The Workspace Model is the canonical source of truth. The Knowledge Graph is a derived, revision-bound representation of that model. Providers can enrich the graph with files, symbols, APIs, tests, infrastructure, ownership, and proofs, but they do not rewrite the model during the same run.
A missing relationship means not proven by current evidence, not “these projects are independent.”
The complete decision loop is versioned as a contract:
Model → Diff → Impact → Doctor + Contract Verify + Analyze → Readiness
→ Verify → Context → Agent Sync → Explain
The model, graph, and verification chain run locally and do not require an AI API key. AI providers are optional consumers of the same governed context.
- Developers get clear summaries, proof paths, and next actions.
- CI gets structured JSON and versioned evidence.
- AI agents get focused context instead of an unbounded repository dump.
- IDEs and dashboards read the same model, graph, and verification results.
- MCP clients can query current workspace evidence.
- Graph tools can use JSON, JSON-LD, Mermaid, DOT, GraphML, or GEXF exports.
| Goal | Guide |
|---|---|
| Learn the main concepts | Plain-language glossary |
| Create, adopt, or import software | Creating workspaces and projects |
| Query the graph and inspect proof | Workspace Knowledge Graph |
| Understand the full decision loop | Workspace Intelligence runner |
| Integrate CI | CI workflows |
| Find a command or flag | Command reference |
| Inspect schemas and artifact ownership | Artifact Catalog |
The current CLI already includes the integrated Workspace Intelligence capabilities described above.
Shared and graph foundations are being hardened as future independent packages. They are extraction boundaries for existing capabilities, not a list of missing features.
npm ci
npm run build
npm testRead the Development Guide, Contributing Guide, and README content contract.
Workspai is an open-source project by Chistiq, the intelligence infrastructure company behind RapidKit and Workspai.
MIT. See LICENSE.
