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
+19-15Lines changed: 19 additions & 15 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.
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.
-`aisee:knowledge` guides day-to-day CLI usage for onboarding, sync, retrieval, and promote.
461
-
-`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.
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.
462
468
- Query through the CLI instead of letting AI scan `knowledge/cards/**/*.md` directly.
463
469
- Return a small number of bounded matches as implementation, review, or verification reminders.
464
470
- Project-local `aisee/docs/reflect/knowledge-candidates/` remains a candidate area and is not promoted automatically.
@@ -477,10 +483,8 @@ plugins/aisee-plugin/
477
483
references/ Cross-skill contracts and references
478
484
bin/ Local CLI entrypoint
479
485
src/aisee_cli/ Aisee Python CLI
480
-
src/aisee_plugin_assets/
481
-
Minimal compatibility package; no bundled skills, schemas, references, or plugin metadata
482
-
docs/ User workflow, best practices, architecture, plans, and review docs
483
-
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.
555
-
-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.
Copy file name to clipboardExpand all lines: docs/compatibility-policy.en.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,8 +90,8 @@ The following are public contracts:
90
90
91
91
-`plugins/aisee-plugin/.codex-plugin/plugin.json`, `plugins/aisee-plugin/skills/`, `plugins/aisee-plugin/references/`, and schema pack directories in the GitHub repository remain loadable by the Codex marketplace plugin;
92
92
- the core / optional / knowledge / hardware layering defined in `plugins/aisee-plugin/references/skill-taxonomy.md`, including the core set of 10 workflow skills;
93
-
-`aisee plugin inspect --json` returns stable status and setup hints in CLI-only installs;
94
-
- the PyPI wheel only promises CLI capabilities; skills, references, schema packs, team knowledge templates, and plugin metadata are distributed through the marketplace plugin or external repositories.
93
+
-`aisee plugin inspect --json` returns stable status and setup hints in PyPI / pipx installs;
94
+
- the PyPI / pipx channel only promises CLI capabilities; skills, references, schema packs, team knowledge templates, and plugin metadata are distributed through the marketplace plugin or external repositories.
95
95
96
96
Breaking changes include renaming the plugin, removing the Codex manifest, breaking the marketplace plugin root layout, or changing the core workflow skill set.
97
97
@@ -116,7 +116,7 @@ The following are public contracts:
116
116
- the planning-doc frontmatter contract and the read-only diagnostics exposed through `aisee doctor --json` and `aisee context pack --json`;
117
117
- the basic semantics of planning-doc fields such as `status`, `doc_type`, `source_refs`, and `change_refs`;
118
118
-`resolve_project_root` preferring the nearest Aisee/OpenSpec project marker before falling back to the Git top-level;
119
-
- release smoke checks for CLI-only wheels, marketplace setup hints, the public command surface, and root-resolver fixtures.
119
+
- release smoke checks for the PyPI / pipx CLI, marketplace setup hints, the public command surface, and root-resolver fixtures.
120
120
121
121
Breaking changes include turning planning-doc diagnostics into write commands or changing root resolution so monorepo subprojects are silently interpreted as repository roots.
Copy file name to clipboardExpand all lines: docs/plugin-marketplace.en.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ PyPI / pipx
13
13
-> provides project-local JSON context tooling, OpenSpec companion checks, project memory, team knowledge, and version/distribution governance commands
14
14
```
15
15
16
-
Marketplace installation does not install the `aisee` CLI. PyPI / pipx installation does not install bundled skills, schema packs, references, or team knowledge templates.
16
+
Marketplace installation does not install the `aisee` CLI. PyPI / pipx installation provides only the CLI; skills, schema packs, references, and team knowledge templates come from the marketplace plugin.
17
17
18
18
## Codex Install
19
19
@@ -79,7 +79,7 @@ Recommended relationship:
79
79
Not recommended:
80
80
81
81
- letting the CLI write Codex marketplace or plugin cache state;
82
-
-bundling a second copy of skills, references, schema packs, or team knowledge templates in the PyPI wheel;
82
+
-copying skills, references, schema packs, or team knowledge templates into the PyPI / pipx distribution channel;
83
83
- treating marketplace listings as project sources of truth for OpenSpec, schemas, source-map, or team knowledge;
84
84
- forcing Codex marketplace fields onto Claude / Cursor metadata.
85
85
@@ -91,7 +91,7 @@ The following are Aisee public contracts:
91
91
- Codex manifest `skills` points to a loadable skills directory;
92
92
- Codex marketplace setup commands;
93
93
- base JSON semantics for CLI `status`, `issues`, `summary`, `meta`, and setup hints;
94
-
- public legacy commands return stable deprecation/blocker JSON during migration instead of silently writing old wheel assets.
94
+
- public legacy commands return stable deprecation/blocker JSON during migration instead of silently writing old content assets.
95
95
96
96
The following are not stable:
97
97
@@ -113,4 +113,4 @@ Also confirm manually:
113
113
114
114
-`plugins/aisee-plugin/.codex-plugin/plugin.json` has no unsupported fields;
115
115
-`.agents/plugins/marketplace.json` points at the `./plugins/aisee-plugin` plugin root;
116
-
-`pipx install aisee-plugin` validates the CLI only and does not assume plugin content exists inside the wheel.
116
+
-`pipx install aisee-plugin` validates the CLI only and does not assume PyPI / pipx installation also provides plugin content.
0 commit comments