You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.en.md
+61-16Lines changed: 61 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,9 +31,15 @@
31
31
32
32
**Aisee** stands for **AI-Enhanced Software Engineering**.
33
33
34
-
Aisee Plugin is an AI software engineering plugin for OpenSpec workflows. It helps teams turn ambiguous ideas into reviewable requirements, UI content specifications, architecture context, schema-aware OpenSpec changes, implementation briefs, verification checks, and archive guardrails.
34
+
Aisee Plugin is an AI software engineering plugin for OpenSpec workflows. It helps teams turn ambiguous ideas into reviewable requirements, UI content specifications, architecture context, OpenSpec changes, project memory, team knowledge guardrails, implementation briefs, verification checks, and archive guardrails.
35
35
36
-
Aisee **does not replace OpenSpec**. OpenSpec remains the specification state machine and baseline source of truth. Aisee adds structured skills, schema packs, JSON context tooling, and engineering handoff rules around OpenSpec.
36
+
Aisee **does not replace OpenSpec**. OpenSpec remains the specification state machine and baseline source of truth. Aisee adds structured skills, project memory, team knowledge, JSON context tooling, and engineering handoff rules around OpenSpec.
37
+
38
+
## OpenSpec Boundary
39
+
40
+
Aisee does not replace OpenSpec and does not maintain a second schema state machine. Aisee reads the current schema declaration only when handling OpenSpec changes, context packs, or schema pack checks; project memory and team knowledge remain guidance / guardrails.
41
+
42
+
When Aisee handles OpenSpec artifacts, it acts only as a parser / checker / projector. `openspec validate` and `openspec archive` remain OpenSpec responsibilities.
37
43
38
44
## Why Aisee?
39
45
@@ -43,10 +49,10 @@ Aisee makes that context explicit:
43
49
44
50
- clarify business requirements before implementation;
45
51
- separate requirements, UI content, architecture context, and change planning;
46
-
- create and complete OpenSpec changes with schema-aware guidance;
52
+
- create and complete OpenSpec changes while reading required artifacts from the current schema;
47
53
- keep OpenSpec as the only persistent specification source of truth;
48
54
- generate machine-readable context packs for implementation, verification, and review;
49
-
- constrain document-local numbering through schemas and skills to reduce invented or duplicated labels;
55
+
- constrain document-local numbering through skills/templates to reduce invented or duplicated labels;
50
56
- check whether artifacts, tasks, source maps, tests, and review evidence are closed before archive.
-**OpenSpec schema pack**: includes app, device, docsite, infra, security, quick-fix, quick-research, and collaboration schemas.
126
132
-**Context packs**: `aisee context pack` generates JSON context for implementation, verification, and review.
133
+
-**Project memory**: `aisee memory` retrieves and writes current-repository long-lived guidance without replacing OpenSpec facts.
127
134
-**Team knowledge guardrails**: `aisee knowledge` retrieves a small number of reviewed engineering lessons through pack/card protocols without turning the knowledge repository into a second specification source.
128
135
-**Lightweight context routing**: `aisee context pack` parses sources, local numbers, candidate paths, and evidence entries when `source-map.md` exists.
129
136
-**Verification and archive guardrails**: `aisee:verify` and `aisee:archive-guard` diagnose gaps and risks before archive.
Schema packs come from the marketplace-installed plugin. `aisee schemas list/check` only reports project-installed schema state or source-checkout development schema state; it does not install schemas from the PyPI wheel.
257
+
Schema packs come from the marketplace-installed plugin. `aisee schemas list/check` only reports project-installed schema state or source-checkout development schema state; it does not install schemas automatically.
251
258
252
259
Check the project state again:
253
260
@@ -315,6 +322,8 @@ For existing projects, use `aisee:spec-migrate` to derive OpenSpec baseline spec
| `aisee:knowledge` | Guide team knowledge CLI initialization, configuration, sync, retrieval, and promote workflows. |
318
327
| `aisee:knowledge-curate` | Batch-review project-local reusable knowledge candidates and produce card drafts for human submission to team knowledge. |
319
328
320
329
Hardware-related skills are retained but still being integrated into the main Aisee workflow:
- JSON output is a context view, not a source of truth.
400
+
-`aisee memory` manages current-repository project memory; `aisee/cache/memory-index.json` is a deletable rebuildable cache.
385
401
-`aisee/cache/knowledge-index.json` is also a deletable and rebuildable cache; team knowledge persists in pinned pack/card files.
386
402
-`aisee knowledge promote-batch` only writes the local team knowledge worktree; it does not commit, push, or create PRs.
387
403
- OpenSpec artifacts and `source-map.md` are formal inputs for context packs.
388
404
-`bootstrap --plan` is a read-only plan and does not perform broad initialization writes.
389
405
-`aisee openspec ensure` only bridges OpenSpec initialization and profile setup. It does not replace `aisee:init`.
390
406
-`aisee knowledge query` returns only a small number of guardrails. By default it reads pack manifests and card frontmatter; `--debug` is required for matched card body excerpts.
391
407
408
+
### Project Memory
409
+
410
+
Project memory stores current-repository guidance that is long-lived but does not belong in the OpenSpec baseline, such as stable preferences, architecture decision summaries, time-bound context snapshots, and stack constraints.
aisee memory add --type pref --title "Commit message language" --summary "Use Chinese commit messages by default." --body "Project commit messages should be Chinese and follow AGENTS.md." --source-ref AGENTS.md --priority high --json
-`aisee:memory` guides day-to-day CLI usage; `aisee:reflect` still owns retrospective candidates.
426
+
- Default retrieval returns a small number of active metadata entries; use `--include-body` explicitly for bounded body excerpts.
427
+
- New writes go only to canonical `aisee/memory/`; legacy `.memory/` is read-only fallback.
428
+
- Hooks are read-only and can only hint `inspect/search` plus a few high-priority summaries.
429
+
- Project memory is guidance. If it conflicts with OpenSpec artifacts, `source-map.md`, or `tasks.md`, OpenSpec artifacts win.
430
+
392
431
### Team Knowledge Guardrails
393
432
394
433
Team knowledge is experimental. It reuses engineering lessons across projects, but it does not replace OpenSpec, `source-map.md`, contracts, tasks, or baseline specs.
-`install`, `update`, and `promote-batch` are experimental. The PyPI CLI no longer provides local default scaffolding. PR automation and MCP service support are still unsettled.
466
+
-`aisee:knowledge` guides day-to-day CLI usage for onboarding, sync, retrieval, and promote.
467
+
-`install`, `update`, and `promote-batch` are experimental. Team knowledge examples come from the marketplace plugin or external repositories; PR automation and MCP service support are still unsettled.
421
468
- Query through the CLI instead of letting AI scan `knowledge/cards/**/*.md` directly.
422
469
- Return a small number of bounded matches as implementation, review, or verification reminders.
423
470
- Project-local `aisee/docs/reflect/knowledge-candidates/` remains a candidate area and is not promoted automatically.
@@ -436,10 +483,8 @@ plugins/aisee-plugin/
436
483
references/ Cross-skill contracts and references
437
484
bin/ Local CLI entrypoint
438
485
src/aisee_cli/ Aisee Python CLI
439
-
src/aisee_plugin_assets/
440
-
Minimal compatibility package; no bundled skills, schemas, references, or plugin metadata
441
-
docs/ User workflow, best practices, architecture, plans, and review docs
442
-
docs/architecture/ Architecture and historical decision docs
486
+
docs/ User workflow, best practices, architecture, and release docs
- Keep CLI JSON, schema packs, context packs, marketplace plugin content, and skill contracts aligned with the Compatibility Policy; when a public contract changes, update tests, migration notes, and release notes together.
514
-
-Add more real-world lifecycle fixtures beyond the app scenario, starting with quick-fix, quick-research, docsite, and infra-change.
558
+
- Keep CLI JSON, project memory, team knowledge, context packs, marketplace plugin content, and skill contracts aligned with the Compatibility Policy; when a public contract changes, update tests, migration notes, and release notes together.
559
+
-Use real-project dogfood to verify memory retrieval, context pack handoffs, and knowledge guardrails instead of expanding abstract flows just to cover schema types.
0 commit comments