workspai 0.79.0 → 0.79.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +117 -236
- package/dist/autopilot-release-E7ADQH2B.js +1 -0
- package/dist/{chunk-EPFEUMYF.js → chunk-5MRDPZU7.js} +1 -1
- package/dist/{chunk-FVG5FBA4.js → chunk-5NS322HT.js} +28 -28
- package/dist/{chunk-B6FJ6RG6.js → chunk-6CZQXEZ7.js} +1 -1
- package/dist/{chunk-7MIOAM4A.js → chunk-CAGOLU4Q.js} +1 -1
- package/dist/{chunk-ZDLF77IS.js → chunk-DYSFGHV5.js} +1 -1
- package/dist/{chunk-4H3VNKOJ.js → chunk-FJMUBFXO.js} +1 -1
- package/dist/{chunk-HXTNPR3M.js → chunk-GIP7YFWR.js} +1 -1
- package/dist/{chunk-BGUCDG5N.js → chunk-IF2OWXNY.js} +1 -1
- package/dist/{chunk-KTOKU6HQ.js → chunk-L3O2QXKH.js} +1 -1
- package/dist/{chunk-CJBDYDVC.js → chunk-LQYMYRGI.js} +1 -1
- package/dist/{chunk-7SN4V3RC.js → chunk-MJYWGRCY.js} +1 -1
- package/dist/{chunk-H24MEOML.js → chunk-NZQKHGPE.js} +1 -1
- package/dist/chunk-WJKQTX4V.js +2 -0
- package/dist/{chunk-GUCZOQUS.js → chunk-ZXYTWF2R.js} +1 -1
- package/dist/{create-M3TWRHV6.js → create-2ETTECFU.js} +1 -1
- package/dist/{doctor-FF3WLJSP.js → doctor-3F7OUVYQ.js} +1 -1
- package/dist/{goal-interactive-selection-6YJOK4WC.js → goal-interactive-selection-EMHAM5TM.js} +1 -1
- package/dist/{goal-lifecycle-O4MYYTRU.js → goal-lifecycle-PR5O7T6B.js} +1 -1
- package/dist/{goal-pack-NUDKANPM.js → goal-pack-TEK2PHAV.js} +1 -1
- package/dist/index.js +158 -158
- package/dist/{pipeline-V5P2FX2P.js → pipeline-E6YY65GU.js} +1 -1
- package/dist/{project-agent-entry-6O7FKWSL.js → project-agent-entry-MXAHZSQR.js} +1 -1
- package/dist/{project-intelligence-lens-OQTZ4K7L.js → project-intelligence-lens-IUM66OV2.js} +1 -1
- package/dist/{proof-carrying-change-GV37YLDQ.js → proof-carrying-change-XA5HRGSB.js} +1 -1
- package/dist/{verified-goal-VB7IOTNO.js → verified-goal-V5OVULY7.js} +1 -1
- package/dist/{workspace-AXU6ODER.js → workspace-XVPKQG5W.js} +1 -1
- package/dist/{workspace-agent-sync-6427FNME.js → workspace-agent-sync-46L7ZOQQ.js} +1 -1
- package/dist/{workspace-foundation-GYL3D7TW.js → workspace-foundation-PZNZWUJ4.js} +1 -1
- package/dist/{workspace-intelligence-runner-2EJ7GXG5.js → workspace-intelligence-runner-NZFRFCPN.js} +1 -1
- package/dist/{workspace-mcp-serve-BSA6Q4EB.js → workspace-mcp-serve-TIYCW364.js} +1 -1
- package/dist/{workspace-onboarding-NH4WFJ5N.js → workspace-onboarding-WUO6KCLF.js} +1 -1
- package/dist/{workspace-repair-engine-ODTFFM6O.js → workspace-repair-engine-V4Z7TJGS.js} +1 -1
- package/dist/workspace-run-T65CCZIN.js +1 -0
- package/docs/README.md +48 -116
- package/docs/ci-workflows.md +7 -1
- package/docs/creating-workspaces-and-projects.md +5 -0
- package/package.json +2 -2
- package/dist/autopilot-release-MDMVMU67.js +0 -1
- package/dist/chunk-ICPL4WNK.js +0 -2
- package/dist/workspace-run-VDQ6BYLS.js +0 -1
- /package/dist/{chunk-SV7X5LJW.js → chunk-GOOY7I36.js} +0 -0
package/README.md
CHANGED
|
@@ -7,149 +7,96 @@
|
|
|
7
7
|
|
|
8
8
|
## Give your AI agent the system, not just the repository
|
|
9
9
|
|
|
10
|
-
**
|
|
10
|
+
**Less rediscovery. More time building.**
|
|
11
|
+
|
|
12
|
+
Give your coding agent a system map, source references, and saved project context.
|
|
13
|
+
Use the same evidence yourself to understand the code and decide what to do next.
|
|
11
14
|
|
|
12
15
|
> One workspace. One truth. Humans and AI aligned.
|
|
13
16
|
|
|
14
17
|
## Workspace Intelligence for software systems
|
|
15
18
|
|
|
16
|
-
Workspai is an open-source CLI that
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
npx workspai adopt .
|
|
21
|
-
npx workspai workspace intelligence run --for-agent generic
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
Two commands. Your project gains a bounded, evidence-backed system view:
|
|
25
|
-
|
|
26
|
-
### Before vs After
|
|
27
|
-
|
|
28
|
-
| Before Workspai | After Workspai |
|
|
29
|
-
| -------------------------------------------- | ----------------------------------------------------- |
|
|
30
|
-
| Agent scans thousands of files for context | Agent starts from bounded entry and context artifacts |
|
|
31
|
-
| No dependency map between services | Searchable graph with source-level proof |
|
|
32
|
-
| Broken test blocks release, no one knows why | Doctor localizes the blocker and next target |
|
|
33
|
-
| Every AI session starts from scratch | Sessions resume from durable evidence |
|
|
34
|
-
|
|
35
|
-
Here is what you get:
|
|
36
|
-
|
|
37
|
-
| What it produces | Why it matters |
|
|
38
|
-
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
39
|
-
| **Workspace Model** | A canonical inventory of registered projects, detected runtimes, frameworks, and proven dependencies |
|
|
40
|
-
| **Knowledge Graph** | Searchable relationships between projects, backed by source-level proof |
|
|
41
|
-
| **Health & Readiness** | Doctor checks, verification gates, and release posture based on evidence, not guesses |
|
|
42
|
-
| **Agent Context** | Bounded, focused instructions so AI tools read what they need, not the entire repo |
|
|
43
|
-
| **Agent Rules** | Ready-to-use grounding for Cursor, Copilot, Claude, Codex, Gemini, and more |
|
|
44
|
-
| **Agent Skills** | Runtime-, polyglot-, test-, and delivery-aware operational playbooks, with portable `SKILL.md` projections where the host supports Agent Skills |
|
|
45
|
-
| **MCP Server** | Versioned read-oriented tools for querying evidence, graph, blockers, and context live |
|
|
46
|
-
|
|
47
|
-
`generic` is the safe default when you do not yet know which agent will use the
|
|
48
|
-
project: Workspai builds one portable context and prepares discovery adapters
|
|
49
|
-
for every supported host, without duplicating the Model or Graph.
|
|
19
|
+
Workspai is an open-source CLI that helps you understand software and prepare
|
|
20
|
+
focused context for Codex, Claude Code, Cursor, and GitHub Copilot.
|
|
21
|
+
The system map and checks do not require an AI API key.
|
|
50
22
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
The canonical workspace owns the Model, Graph, context, evidence index, and
|
|
54
|
-
Skills. Each linked project keeps only its portable entry, scoped context, and
|
|
55
|
-
workspace binding:
|
|
56
|
-
|
|
57
|
-
```text
|
|
58
|
-
your-workspace/
|
|
59
|
-
├── .workspai/
|
|
60
|
-
│ ├── reports/ # Model, Graph, verification, context
|
|
61
|
-
│ └── skills/ # evidence-derived playbooks
|
|
62
|
-
├── AGENTS.md · .codex/ · .cursor/ · .claude/ · .github/ · .agents/
|
|
63
|
-
└── project/.workspai/
|
|
64
|
-
├── agent-entry.v1.json # portable project entry
|
|
65
|
-
└── workspace-link.local.json # machine-local binding
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Your agent starts with `agent-entry.v1.json`, compact workspace context, and the
|
|
69
|
-
Skills index; it then retrieves task-scoped Graph evidence and targeted source.
|
|
70
|
-
|
|
71
|
-

|
|
72
|
-
|
|
73
|
-
[Get started](#start-in-two-minutes) ·
|
|
74
|
-
[See what you get](#what-happens-after-the-first-run) ·
|
|
75
|
-
[How it works](#how-workspace-intelligence-works) ·
|
|
23
|
+
[Quickstart](#start-in-two-minutes) ·
|
|
24
|
+
[Agent setup](docs/agent-entry.md) ·
|
|
76
25
|
[Documentation](docs/README.md)
|
|
77
26
|
|
|
78
27
|
## Start in two minutes
|
|
79
28
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
Open the project and adopt it:
|
|
29
|
+
From the directory of your existing project:
|
|
83
30
|
|
|
84
31
|
```bash
|
|
85
|
-
cd /absolute/path/to/project
|
|
86
32
|
npx workspai adopt .
|
|
33
|
+
npx workspai workspace intelligence run --for-agent generic
|
|
87
34
|
```
|
|
88
35
|
|
|
89
|
-
|
|
90
|
-
|
|
36
|
+
Requires **Node.js 20.19+ and npm**. Your source stays in place. Workspai adds
|
|
37
|
+
project metadata and agent entry files, creates or reuses a linked workspace,
|
|
38
|
+
and saves shared reports there. `generic` prepares context for supported agent
|
|
39
|
+
hosts without requiring you to choose one yet. Run time depends on your project.
|
|
91
40
|
|
|
92
|
-
|
|
41
|
+
**Read the terminal summary:** which projects were detected, where context was
|
|
42
|
+
saved, and which checks need attention. Rerun the intelligence command after
|
|
43
|
+
changes to refresh the saved view.
|
|
93
44
|
|
|
94
|
-
|
|
95
|
-
npx workspai workspace intelligence run --for-agent generic
|
|
96
|
-
```
|
|
45
|
+

|
|
97
46
|
|
|
98
|
-
|
|
99
|
-
`--workspace <path>` when a moved or ambiguous binding cannot be resolved.
|
|
100
|
-
The shorter command is intended for a human-readable first run. CI, agents, and
|
|
101
|
-
other machine consumers should use the strict JSON form shown in
|
|
102
|
-
[How Workspace Intelligence works](#how-workspace-intelligence-works).
|
|
47
|
+
### Create a workspace or a new project
|
|
103
48
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
Use the guided flow:
|
|
49
|
+
Build from a starter instead of setting up every project by hand:
|
|
107
50
|
|
|
108
51
|
```bash
|
|
109
52
|
npx workspai create
|
|
110
53
|
```
|
|
111
54
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
55
|
+
- **Create a workspace:** organize your projects with shared context and checks.
|
|
56
|
+
- **Create a project:** pick a category, kit, and name; scaffold and register it.
|
|
57
|
+
- **Add existing software:** connect a local project, Git repository, or workspace.
|
|
115
58
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
59
|
+
| Build… | Choose from starters such as… |
|
|
60
|
+
| --- | --- |
|
|
61
|
+
| A backend | FastAPI, NestJS, Go, ASP.NET Core, Rust Axum, Spring Boot |
|
|
62
|
+
| A frontend | Next.js, React + Vite, Vue, Angular, Astro, SvelteKit |
|
|
63
|
+
| An AI agent | Google ADK, OpenAI Agents SDK, Microsoft Agent Framework |
|
|
64
|
+
| A model gateway | OpenRouter with Python or TypeScript |
|
|
65
|
+
| A desktop app or extension | Browse the matching category in the picker |
|
|
66
|
+
|
|
67
|
+
The picker shows each kit's support status.
|
|
68
|
+
|
|
69
|
+
Install once with `npm install -g workspai` to use `workspai create`.
|
|
70
|
+
The optional `wspai` package provides the shorter `wspai create` command.
|
|
71
|
+
|
|
72
|
+
[All workspace and project setup options](docs/creating-workspaces-and-projects.md)
|
|
121
73
|
|
|
122
74
|
## Give your agent a goal, not an open-ended prompt
|
|
123
75
|
|
|
124
|
-
|
|
76
|
+
From your linked project:
|
|
125
77
|
|
|
126
78
|
```bash
|
|
127
79
|
npx workspai goal "Raise test coverage to 85%" --for-agent generic
|
|
128
|
-
npx workspai goal "Raise test coverage to 85%" --runtime cpp --for-agent generic
|
|
129
|
-
npx workspai goal "Add retry with exponential backoff" --for-agent generic
|
|
130
80
|
```
|
|
131
81
|
|
|
132
|
-
Workspai
|
|
82
|
+
Workspai prepares scope, acceptance criteria, and an agent handoff.
|
|
83
|
+
The agent gets a focused objective, not permission to scan or change everything.
|
|
84
|
+
The command does not edit source or claim that the outcome is complete.
|
|
85
|
+
Your agent performs the implementation; verification checks the result.
|
|
133
86
|
|
|
134
|
-
|
|
135
|
-
Intent → project scope → proof-backed context → governed plan → safe execution
|
|
136
|
-
```
|
|
87
|
+
[Goal guide, including multi-project and runtime choices](docs/goal-packs.md)
|
|
137
88
|
|
|
138
|
-
|
|
139
|
-
everything. Workspai keeps approval, verification, and rollback under CLI
|
|
140
|
-
control. The command prepares governed work; it does not edit source or claim
|
|
141
|
-
that the outcome is complete. Exact coverage, dependency-security, and release
|
|
142
|
-
Goals have deterministic CLI verifiers; other outcomes retain CLI safety and
|
|
143
|
-
rollback while the consumer performs an evidence-backed outcome review.
|
|
144
|
-
Multi-project scope and polyglot runtime choices are explicit. Interactive
|
|
145
|
-
users get bounded choices from the canonical Workspace Model; automation gets
|
|
146
|
-
a machine-readable decision and can use `--scope` and `--runtime`.
|
|
89
|
+
## Make every agent change carry proof
|
|
147
90
|
|
|
148
|
-
|
|
91
|
+
Need an audit trail? **Proof-Carrying Change** connects the goal to authorized
|
|
92
|
+
changes, observed effects, and independent verification.
|
|
93
|
+
Prediction can guide work but can never prove its own result.
|
|
149
94
|
|
|
150
|
-
|
|
95
|
+
<details>
|
|
96
|
+
<summary>Example change lifecycle — after creating a Goal</summary>
|
|
151
97
|
|
|
152
|
-
|
|
98
|
+
Begin before the first source change; replace placeholders with your change ID
|
|
99
|
+
and actual effect receipt. See the guide for receipt creation and the full loop.
|
|
153
100
|
|
|
154
101
|
```bash
|
|
155
102
|
npx workspai change begin --json
|
|
@@ -159,186 +106,120 @@ npx workspai change verify --change <change-id> --strict --json
|
|
|
159
106
|
npx workspai change capsule validate --change <change-id> --json
|
|
160
107
|
```
|
|
161
108
|
|
|
162
|
-
|
|
163
|
-
observed effects, predicted-versus-actual Graph changes, verification receipts,
|
|
164
|
-
and remaining uncertainty. Prediction can guide work but can never prove its
|
|
165
|
-
own result. [Learn how Proof-Carrying Change works](docs/proof-carrying-change.md).
|
|
109
|
+

|
|
166
110
|
|
|
167
|
-
|
|
111
|
+
</details>
|
|
168
112
|
|
|
169
|
-
|
|
113
|
+
[Record and verify a change](docs/proof-carrying-change.md)
|
|
170
114
|
|
|
171
|
-
|
|
115
|
+
## What happens after the first run
|
|
172
116
|
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
| **AI agent** | `agent-entry.v1.json` (project) → `workspace-context-agent.json` (workspace) |
|
|
176
|
-
| **Developer** | Terminal summary, or `workspace-explain-last-run.json` for diagnosis |
|
|
177
|
-
| **CI / automation** | `workspace-verify-last-run.json` (exit code 0 = pass, 2 = blocked) |
|
|
178
|
-
| **MCP client** | `workspace mcp serve` (versioned read-oriented tools over JSON-RPC) |
|
|
179
|
-
| **IDE extension** | Same artifacts + watch events |
|
|
117
|
+
Your project keeps its agent entry and scoped context. The linked workspace
|
|
118
|
+
keeps shared reports under `.workspai/reports/`. You can stay in the project terminal.
|
|
180
119
|
|
|
181
|
-
|
|
182
|
-
the repository:
|
|
120
|
+
To check the entry before handing work to an agent:
|
|
183
121
|
|
|
184
122
|
```bash
|
|
185
|
-
npx workspai agent bootstrap --for-agent
|
|
123
|
+
npx workspai agent bootstrap --for-agent generic --strict --json
|
|
186
124
|
```
|
|
187
125
|
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
canonical-first agent entry](docs/agent-entry.md).
|
|
192
|
-
|
|
193
|
-
A blocked result is useful evidence, not a crashed command. Workspai names what
|
|
194
|
-
is missing or failing and keeps the generated reports available for inspection.
|
|
126
|
+
A blocked result is useful evidence, not a crashed command.
|
|
127
|
+
Inspect the named check and its report before claiming readiness.
|
|
128
|
+
[Agent setup and entry checks](docs/agent-entry.md)
|
|
195
129
|
|
|
196
130
|
## How Workspace Intelligence works
|
|
197
131
|
|
|
198
|
-
|
|
199
|
-
Workspace
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
Canonical Workspace Model
|
|
203
|
-
│
|
|
204
|
-
▼
|
|
205
|
-
Evidence-backed Knowledge Graph
|
|
206
|
-
│
|
|
207
|
-
▼
|
|
208
|
-
Impact · Doctor · Verify · Context · Explain
|
|
209
|
-
│
|
|
210
|
-
▼
|
|
211
|
-
Humans · CI · IDEs · MCP · AI agents
|
|
212
|
-
```
|
|
213
|
-
|
|
214
|
-
The **Workspace Model is the canonical source of truth**. The Knowledge Graph is
|
|
215
|
-
a **derived, revision-bound representation** of that model. It can add
|
|
216
|
-
proof-backed detail without becoming a second source of truth or mutating the
|
|
217
|
-
model that authorized the run.
|
|
132
|
+
Workspai reads the workspace, builds a map, checks evidence, and prepares context.
|
|
133
|
+
The **Workspace Model is the canonical source of truth**. The graph is a
|
|
134
|
+
**derived, revision-bound representation**; providers enrich it without rewriting
|
|
135
|
+
the model during the same run.
|
|
218
136
|
|
|
219
|
-
A missing relationship means **not proven
|
|
220
|
-
projects are independent."
|
|
137
|
+
A missing relationship means **not proven**, not "these projects are independent."
|
|
221
138
|
|
|
222
|
-
|
|
139
|
+
<details>
|
|
140
|
+
<summary>The full intelligence chain and CI command</summary>
|
|
223
141
|
|
|
224
142
|
```text
|
|
225
143
|
Model → Diff → Impact → Doctor + Contract Verify + Analyze → Readiness
|
|
226
144
|
→ Verify → Context → Agent Sync → Explain
|
|
227
145
|
```
|
|
228
146
|
|
|
229
|
-
Run it with:
|
|
230
|
-
|
|
231
147
|
```bash
|
|
232
148
|
npx workspai workspace intelligence run --for-agent generic --strict --json
|
|
233
149
|
```
|
|
234
150
|
|
|
235
|
-
`pipeline --json --strict` is the broader release
|
|
236
|
-
complements this
|
|
151
|
+
`pipeline --json --strict` is the broader release/governance workflow and
|
|
152
|
+
complements this runner.
|
|
153
|
+
|
|
154
|
+
</details>
|
|
237
155
|
|
|
238
|
-
|
|
156
|
+
[Runner behavior and exit codes](docs/workspace-intelligence-runner.md)
|
|
239
157
|
|
|
240
|
-
|
|
158
|
+
<details>
|
|
159
|
+
<summary>See a workspace graph</summary>
|
|
241
160
|
|
|
242
|
-
|
|
243
|
-
and runtime topology only when current evidence supports the relationship.
|
|
244
|
-
Every visible relationship can retain proof, while missing relationships stay
|
|
245
|
-
explicitly unproven.
|
|
161
|
+

|
|
246
162
|
|
|
247
|
-
|
|
163
|
+
[Explore the graph](docs/workspace-knowledge-graph.md)
|
|
248
164
|
|
|
249
|
-
|
|
165
|
+
</details>
|
|
250
166
|
|
|
251
167
|
## Everyday workflows
|
|
252
168
|
|
|
253
|
-
|
|
|
254
|
-
|
|
|
255
|
-
|
|
|
256
|
-
|
|
|
257
|
-
|
|
|
258
|
-
|
|
|
259
|
-
|
|
|
260
|
-
| Prove an agent change from intent to verify | `npx workspai change begin --json` |
|
|
261
|
-
| Ground an agent before source discovery | `npx workspai agent bootstrap --for-agent generic --strict --json` |
|
|
262
|
-
| Copy or clone a project into a workspace | `npx workspai import <path-or-git-url> --workspace <path>` |
|
|
263
|
-
| Diagnose project or workspace health | `npx workspai doctor project` / `npx workspai doctor workspace` |
|
|
264
|
-
| Observe CLI and Studio activity | `npx workspai live --once --json --projection board` |
|
|
265
|
-
| Ask a focused architecture question | `npx workspai workspace graph search "authentication service" --limit 12 --json` |
|
|
266
|
-
| Verify current evidence | `npx workspai workspace verify --strict --json` |
|
|
267
|
-
| Inspect a governed repair before execution | `npx workspai workspace repair capabilities --json` |
|
|
268
|
-
| Refresh agent and IDE context | `npx workspai workspace agent-sync --write --preset enterprise --json` |
|
|
269
|
-
| Run the broader release gate | `npx workspai pipeline --strict --json` |
|
|
270
|
-
| Start MCP server for workspace queries | `npx workspai workspace mcp serve` |
|
|
271
|
-
|
|
272
|
-
For every command and flag, use the
|
|
273
|
-
[Command Reference](docs/commands-reference.md).
|
|
169
|
+
| You want to… | Run |
|
|
170
|
+
| --- | --- |
|
|
171
|
+
| Refresh context and checks | `npx workspai workspace intelligence run --for-agent generic` |
|
|
172
|
+
| Explore a topic from your code | `npx workspai workspace graph search "authentication" --limit 5 --json` |
|
|
173
|
+
| Diagnose your project or workspace | `npx workspai doctor project` / `npx workspai doctor workspace` |
|
|
174
|
+
| Start a new project | `npx workspai create` |
|
|
175
|
+
| Serve workspace queries to an MCP client | `npx workspai workspace mcp serve` |
|
|
274
176
|
|
|
275
|
-
|
|
177
|
+
Search results include evidence references. Follow them before changing code.
|
|
178
|
+
[All commands and flags](docs/commands-reference.md)
|
|
276
179
|
|
|
277
|
-
|
|
180
|
+
## Outputs and integrations
|
|
278
181
|
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
- MCP server with versioned read-oriented workspace tools (`workspace mcp serve`);
|
|
284
|
-
- Live activity projections and reports for IDEs and dashboards;
|
|
285
|
-
- JSON, JSON-LD, Mermaid, DOT, GraphML, and GEXF graph exports.
|
|
182
|
+
Use terminal summaries for a first look, JSON for automation, and saved context
|
|
183
|
+
for coding agents. Graph exports include JSON, Mermaid, DOT, GraphML, and GEXF.
|
|
184
|
+
Live activity projections and reports for IDEs and dashboards show current activity;
|
|
185
|
+
activity alone does not prove a change is correct.
|
|
286
186
|
|
|
287
|
-
The [
|
|
288
|
-
uses
|
|
289
|
-
artifacts.
|
|
187
|
+
The [VS Code extension](https://marketplace.visualstudio.com/items?itemName=rapidkit.rapidkit-vscode)
|
|
188
|
+
uses the same CLI and workspace artifacts.
|
|
290
189
|
|
|
291
190
|
## Requirements
|
|
292
191
|
|
|
293
|
-
|
|
294
|
-
-
|
|
295
|
-
|
|
296
|
-
Python, Go, Java, .NET, Rust, or PHP are needed only for workflows that use
|
|
297
|
-
those runtimes. Python is not required for Python-free workspaces or npm-owned
|
|
298
|
-
project generators.
|
|
299
|
-
|
|
300
|
-
RapidKit Core is the optional Python engine for Python/Core-dependent kits and
|
|
301
|
-
modules; Workspai remains the workspace-level CLI.
|
|
192
|
+
Node.js **20.19+** and npm. Other runtimes are needed only for projects and
|
|
193
|
+
workflows that use them. Python is not required for Python-free workflows;
|
|
194
|
+
RapidKit Core supports the Python/Core-dependent kits and modules.
|
|
302
195
|
|
|
303
196
|
## Documentation
|
|
304
197
|
|
|
305
|
-
|
|
|
306
|
-
|
|
|
307
|
-
|
|
|
308
|
-
|
|
|
309
|
-
|
|
|
310
|
-
|
|
|
311
|
-
|
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
| Set a release, security, or coverage outcome | [Verified engineering goals](docs/workspace-intelligence-runner.md#verified-engineering-goals) |
|
|
315
|
-
| Compile plain language into a governed plan | [Goal Packs](docs/goal-packs.md) |
|
|
316
|
-
| Prove what an agent changed and why | [Proof-Carrying Change](docs/proof-carrying-change.md) |
|
|
317
|
-
| Ground an agent in canonical project evidence | [Canonical-first agent entry](docs/agent-entry.md) |
|
|
318
|
-
| Measure bounded retrieval and model usage | [Evaluation](docs/workspace-intelligence-evaluation.md) and [benchmark](docs/workspace-intelligence-benchmark.md) |
|
|
319
|
-
| Integrate CI | [CI workflows](docs/ci-workflows.md) |
|
|
320
|
-
| Find generated files and schemas | [Artifact Catalog](docs/contracts/ARTIFACT_CATALOG.md) |
|
|
321
|
-
| Browse all documentation | [Documentation index](docs/README.md) |
|
|
198
|
+
| Next step | Guide |
|
|
199
|
+
| --- | --- |
|
|
200
|
+
| Create, adopt, or import a project | [Getting started](docs/creating-workspaces-and-projects.md) |
|
|
201
|
+
| Connect your coding agent | [Agent entry](docs/agent-entry.md) |
|
|
202
|
+
| Understand relationships | [Knowledge Graph](docs/workspace-knowledge-graph.md) |
|
|
203
|
+
| Add checks to CI | [CI workflows](docs/ci-workflows.md) |
|
|
204
|
+
| Find a command or understand a term | [Command reference](docs/commands-reference.md) · [Glossary](docs/GLOSSARY.md) |
|
|
205
|
+
|
|
206
|
+
[Browse all guides](docs/README.md)
|
|
322
207
|
|
|
323
208
|
## Troubleshooting
|
|
324
209
|
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
| You need a specific flag | Open the [Command Reference](docs/commands-reference.md) |
|
|
210
|
+
- **Workspace not detected?** Run from your linked project, or inspect
|
|
211
|
+
`npx workspai project workspace status --json`.
|
|
212
|
+
- **Context is stale?** Rerun the intelligence command.
|
|
213
|
+
- **A check is blocked?** Read the named report; adoption does not certify project health.
|
|
214
|
+
- **Agent files need refreshing?** Run
|
|
215
|
+
`npx workspai workspace agent-sync --write --refresh-context --json`.
|
|
332
216
|
|
|
333
217
|
## Contributing
|
|
334
218
|
|
|
335
|
-
|
|
336
|
-
[
|
|
337
|
-
RapidKit and Workspai.
|
|
219
|
+
[Contribution guide](CONTRIBUTING.md) · [Development](docs/DEVELOPMENT.md) ·
|
|
220
|
+
[Security](docs/SECURITY.md)
|
|
338
221
|
|
|
339
|
-
|
|
340
|
-
[Development Guide](docs/DEVELOPMENT.md), and the
|
|
341
|
-
[Security Policy](docs/SECURITY.md).
|
|
222
|
+
Built by [Chistiq](https://chistiq.com/), the team behind RapidKit and Workspai.
|
|
342
223
|
|
|
343
224
|
## License
|
|
344
225
|
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export{b as AUTOPILOT_RELEASE_ALIAS_FILENAME,a as AUTOPILOT_RELEASE_LAST_RUN_FILENAME,c as runAutopilotRelease}from'./chunk-MJYWGRCY.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import a from'path';import Y from'fs-extra';import q from'chalk';async function U(p,n={}){let e=a.resolve(p),{WORKSPACE_CONTRACT_PATH:l,syncWorkspaceContract:d,verifyWorkspaceContract:S,writeWorkspaceContractVerifyEvidence:j}=await import('./workspace-contract-N2BJCAJ7.js'),w=await d({workspacePath:e,strict:true}),{syncWorkspaceReadme:E,WORKSPACE_README_PATH:R}=await import('./workspace-readme-4FCKAQME.js'),x=await E({workspacePath:e,workspaceName:w.contract.workspace.name,profile:w.contract.workspace.profile??"minimal",projectCount:w.contract.projects.length}),{buildWorkspaceModel:h,writeWorkspaceModel:g}=await import('./workspace-model-LBICKRVI.js'),r=await h({workspacePath:e,includeEvidence:true}),k=await g(r,e),{buildWorkspaceImpact:G,buildWorkspaceModelSnapshot:O,diffWorkspaceModel:$,writeWorkspaceImpact:M,writeWorkspaceModelDiff:T,writeWorkspaceModelSnapshot:_}=await import('./workspace-intelligence-ZTET7JHS.js'),{WORKSPACE_INTELLIGENCE_ARTIFACTS:s}=await import('./workspace-intelligence-runtime-registry-ZLPF7BAY.js'),{syncWorkspaceAgentGrounding:P}=await import('./workspace-agent-sync-
|
|
1
|
+
import a from'path';import Y from'fs-extra';import q from'chalk';async function U(p,n={}){let e=a.resolve(p),{WORKSPACE_CONTRACT_PATH:l,syncWorkspaceContract:d,verifyWorkspaceContract:S,writeWorkspaceContractVerifyEvidence:j}=await import('./workspace-contract-N2BJCAJ7.js'),w=await d({workspacePath:e,strict:true}),{syncWorkspaceReadme:E,WORKSPACE_README_PATH:R}=await import('./workspace-readme-4FCKAQME.js'),x=await E({workspacePath:e,workspaceName:w.contract.workspace.name,profile:w.contract.workspace.profile??"minimal",projectCount:w.contract.projects.length}),{buildWorkspaceModel:h,writeWorkspaceModel:g}=await import('./workspace-model-LBICKRVI.js'),r=await h({workspacePath:e,includeEvidence:true}),k=await g(r,e),{buildWorkspaceImpact:G,buildWorkspaceModelSnapshot:O,diffWorkspaceModel:$,writeWorkspaceImpact:M,writeWorkspaceModelDiff:T,writeWorkspaceModelSnapshot:_}=await import('./workspace-intelligence-ZTET7JHS.js'),{WORKSPACE_INTELLIGENCE_ARTIFACTS:s}=await import('./workspace-intelligence-runtime-registry-ZLPF7BAY.js'),{syncWorkspaceAgentGrounding:P}=await import('./workspace-agent-sync-46L7ZOQQ.js'),W=await P({workspacePath:e,model:r,write:true,refreshContext:true,strict:false,preset:"enterprise",targets:["all"],projectGrounding:n.projectGrounding??"managed"}),v=new Set(W.writtenFiles),i=new Set(W.projectLenses?.skipped.map(t=>`${t.name}: ${t.reason}`)??[]),{readWorkspaceKnowledgeGraphSnapshot:C}=await import('./workspace-knowledge-graph-snapshot-UTJHALST.js'),o=await C(e),y=false;if(o.status==="miss"){if(o.reason!=="live-input-mismatch")throw new Error(`Workspace consumer sync could not validate canonical Model/Graph evidence (${o.reason}).`);r=await h({workspacePath:e,includeEvidence:true}),k=await g(r,e);let{buildWorkspaceAgentContext:t,writeWorkspaceAgentContext:f}=await import('./workspace-context-VVZARI5K.js'),m=await t({workspacePath:e,model:r,agent:"generic",includeEvidence:true});await f(m,e);let b=await P({workspacePath:e,model:r,write:true,refreshContext:false,strict:false,preset:"enterprise",targets:["all"],projectGrounding:n.projectGrounding??"managed"});for(let c of b.writtenFiles)v.add(c);for(let c of b.projectLenses?.skipped??[])i.add(`${c.name}: ${c.reason}`);if(o=await C(e),o.status==="miss")throw new Error(`Workspace consumer reconciliation did not produce fresh canonical evidence (${o.reason}).`);y=true;}let F=a.join(e,s.snapshot),u=false;if(!await Y.pathExists(F)){let t=await O({workspacePath:e,model:r});await _(t,e),u=true;}let I=await $({workspacePath:e,fromPath:s.snapshot,model:r}),N=await T(I,e),L=await G({workspacePath:e,fromPath:s.diff}),K=await M(L,e),z=await S({workspacePath:e,strict:true}),H=await j({workspacePath:e,result:z}),V=(o.graph.source.inputs?.scopes??[]).filter(t=>t.truncated);for(let t of V)i.add(`${t.kind}:${t.id} graph inventory reached its ${t.fileLimit}-file emergency bound; inventory completeness is bounded.`);let A=o.graph.quality.completeness?.providers.bounded??0;A>0&&i.add(`${A} graph provider(s) used declared adaptive semantic/deep budgets; inspect provider inputCoverage before making exhaustive symbol-level claims.`);let D=[l,(await import('./workspace-registry-summary-3PXZENLC.js')).WORKSPACE_REGISTRY_SUMMARY_RELATIVE_PATH,a.relative(e,x).split(a.sep).join("/")||R,a.relative(e,k).split(a.sep).join("/"),s.knowledgeGraph,...u?[s.snapshot]:[],a.relative(e,N).split(a.sep).join("/"),a.relative(e,K).split(a.sep).join("/"),a.relative(e,H).split(a.sep).join("/"),...v].filter((t,f,m)=>m.indexOf(t)===f);return n.silent||console.log(q.gray(`\u2713 Workspace Intelligence synced \xB7 ${r.summary.projectCount} project(s) \xB7 model + graph + agent grounding \xB7 freshness sealed`)),{workspacePath:e,projectCount:r.summary.projectCount,baselineCreated:u,freshnessSealed:true,reconciledAfterGrounding:y,writtenFiles:D,warnings:[...i].sort()}}async function ee(p,n={}){let e=a.resolve(p),l=n.workspaceName??a.basename(e),{registerWorkspaceStrict:d}=await import('./workspace-XVPKQG5W.js');return await d(e,l),U(e,{silent:n.silent})}export{U as a,ee as b};
|