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
+13-20Lines changed: 13 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,21 +33,21 @@
33
33
34
34
**Aisee** stands for **AI-Enhanced Software Engineering**.
35
35
36
-
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-stage JSON decisions with optional handoff briefs, verification checks, and archive guardrails.
36
+
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 handoffs, verification checks, and archive guardrails.
37
37
38
38
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.
39
39
40
40
It is especially relevant for maintainers who want Codex and other coding agents to work more reliably in open-source repositories:
41
41
42
42
- durable requirements and specifications instead of transient chat context;
43
-
-machine-readable context packsand schema packs for implementation, review, and verification;
43
+
-OpenSpec artifacts, schema packs, project memory, and team knowledge guardrails for implementation, review, and verification;
44
44
- OpenSpec change planning that turns vague intent into reviewable deliverables;
45
-
-machine-readable implementation-stage decisions with optional handoff briefs that help maintainers and contributors hand off PR-ready work;
45
+
-explicit implementation handoffs and writeback rules that help maintainers and contributors hand off PR-ready work;
46
46
- verification evidence and archive gates that close the loop before AI-assisted changes are treated as complete.
47
47
48
48
## OpenSpec Boundary
49
49
50
-
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.
50
+
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 or schema pack checks; project memory and team knowledge remain guidance / guardrails.
51
51
52
52
When Aisee handles OpenSpec artifacts, it acts only as a parser / checker / projector. `openspec validate` and `openspec archive` remain OpenSpec responsibilities.
53
53
@@ -58,7 +58,7 @@ Codex can write, review, and fix code, but the results are less reliable when a
58
58
Aisee supplies that workflow layer:
59
59
60
60
- it turns intent into durable OpenSpec changes, planning docs, and reusable project memory;
61
-
- it helps maintainers first reduce implementation entry into reusable JSON decisions, and only turn them into human-readable handoff briefs when needed;
61
+
- it helps maintainers reduce implementation entry into clear handoff rules, and only turn them into human-readable briefs when needed;
62
62
- it lets Codex read against the same context boundaries across implementation, review, verification, and archive;
63
63
- it gives open-source projects clearer engineering constraints for AI-assisted contribution flows.
64
64
@@ -72,7 +72,7 @@ Aisee makes that context explicit:
72
72
- separate requirements, UI content, architecture context, and change planning;
73
73
- create and complete OpenSpec changes while reading required artifacts from the current schema;
74
74
- keep OpenSpec as the only persistent specification source of truth;
75
-
-generate machine-readable context packs for implementation, verification, and review;
75
+
-expose durable project memory and team knowledge guardrails without replacing OpenSpec facts;
76
76
- constrain document-local numbering through skills/templates to reduce invented or duplicated labels;
77
77
- check whether artifacts, tasks, source maps, tests, and review evidence are closed before archive.
78
78
@@ -102,7 +102,7 @@ OpenSpec
102
102
Manage active changes, baseline specs, validate, apply, and archive
103
103
↓
104
104
Aisee CLI
105
-
Read OpenSpec/Aisee metadata and emit JSON context packs
105
+
Read OpenSpec/Aisee metadata and provide project memory, team knowledge, and helper checks
106
106
↓
107
107
Compound Engineering or another coding agent
108
108
Implement, review, test, and produce evidence
@@ -154,10 +154,9 @@ On-demand extensions:
154
154
-**Architecture context**: `aisee:architecture` records technical facts, constraints, reusable capabilities, global engineering conventions, and artifact hints.
-**OpenSpec schema pack**: includes app, device, docsite, infra, security, quick-fix, quick-research, and collaboration schemas.
157
-
-**Context packs**: `aisee context pack` provides optional project memory and team knowledge injection for the current change without replacing OpenSpec facts.
158
157
-**Project memory**: `aisee memory` retrieves and writes current-repository long-lived guidance without replacing OpenSpec facts.
159
158
-**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.
160
-
-**Controlled memory injection**: `aisee context pack` injects `project_memory` or `knowledge`only when explicitly requested and does not own implementation-stage routing.
159
+
-**Controlled memory and knowledge retrieval**: `aisee memory` and `aisee knowledge`provide direct retrieval entrypoints without owning implementation-stage routing.
161
160
-**Verification and archive guardrails**: `aisee:verify` and `aisee:archive-guard` diagnose gaps and risks before archive.
162
161
-**Harness design**: CLI contract tests and normalized skill eval cases keep the workflow stable.
163
162
@@ -304,8 +303,8 @@ aisee doctor --json
304
303
305
304
-[Documentation site](https://aisee.wiki): Aisee guides, workflows, and release notes.
306
305
-[Aisee Workflow](docs/workflow.en.md): end-to-end guidance from setup, requirement clarification, change authoring, implementation handoff, verification, and archive.
307
-
-[Aisee Best Practices](docs/best-practices.en.md): conventions for sources of truth, schemas, contracts, context packs, reuse-first routing, review, and archive when using Aisee with OpenSpec.
308
-
-[Compatibility Policy](docs/compatibility-policy.en.md): compatibility boundaries for CLI JSON, schema packs, context packs, plugin content, and experimental capabilities.
306
+
-[Aisee Best Practices](docs/best-practices.en.md): conventions for sources of truth, schemas, contracts, reuse-first routing, review, and archive when using Aisee with OpenSpec.
307
+
-[Compatibility Policy](docs/compatibility-policy.en.md): compatibility boundaries for CLI JSON, schema packs, plugin content, and experimental capabilities.
309
308
-[Plugin Marketplace](docs/plugin-marketplace.en.md): responsibilities of plugin manifests, marketplace listings, PyPI/pipx, and the Codex install path.
310
309
-[Team Knowledge Guardrails](docs/team-knowledge.en.md): experimental status, usage, and gaps before stability for shared team knowledge.
311
310
-[Aisee Team Knowledge Architecture](docs/architecture/aisee-team-knowledge.md): team knowledge guardrail retrieval, card/pack boundaries, CLI onboarding, and read model.
-`aisee memory` manages current-repository project memory; `aisee/cache/memory-index.json` is a deletable rebuildable cache.
440
435
-`aisee/cache/knowledge-index.json` is also a deletable and rebuildable cache; team knowledge persists in pinned pack/card files.
441
436
-`aisee knowledge promote-batch` only writes the local team knowledge worktree; it does not commit, push, or create PRs.
442
-
- OpenSpec artifacts and `source-map.md` are formal inputs for context packs.
443
437
-`bootstrap --plan` is a read-only plan and does not perform broad initialization writes.
444
438
-`aisee openspec ensure` installs or refreshes project-local OpenSpec instructions/skills and also aligns the global profile. It does not replace `aisee:init`.
445
439
-`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.
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
- 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.
598
-
- Use real-project dogfood to verify memory retrieval, context pack handoffs, and knowledge guardrails instead of expanding abstract flows just to cover schema types.
590
+
- Keep CLI JSON, project memory, team knowledge, marketplace plugin content, and skill contracts aligned with the Compatibility Policy; when a public contract changes, update tests, migration notes, and release notes together.
591
+
- Use real-project dogfood to verify memory retrieval, implementation handoffs, and knowledge guardrails instead of expanding abstract flows just to cover schema types.
0 commit comments