aimship 0.1.0-preview.7 → 0.1.0-preview.9
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/CONTRIBUTING.md +52 -1
- package/README.md +120 -58
- package/README.zh-CN.md +120 -58
- package/docs/cli.md +32 -2
- package/docs/guide.md +187 -187
- package/docs/guide.zh-CN.md +187 -187
- package/docs/installation.md +12 -8
- package/lib/approvals.mjs +153 -0
- package/lib/cli.mjs +11 -7
- package/lib/delivery.mjs +76 -0
- package/lib/documents.mjs +5 -4
- package/lib/state.mjs +39 -9
- package/lib/view.mjs +13 -2
- package/package.json +1 -1
- package/skills/aimship/SKILL.md +3 -3
- package/skills/aimship/references/artifact-map.json +21 -12
- package/skills/aimship/references/core.md +25 -5
- package/skills/aimship/references/document-patterns.md +4 -2
- package/skills/aimship/references/document-review.md +28 -0
- package/skills/aimship/references/recovery.md +8 -0
- package/skills/aimship/references/sources-and-changes.md +2 -0
- package/skills/aimship/references/stages/contract.md +7 -3
- package/skills/aimship/references/stages/diagnose.md +4 -0
- package/skills/aimship/references/stages/handoff.md +2 -0
- package/skills/aimship/references/stages/plan.md +6 -2
- package/skills/aimship/references/stages/prototype.md +4 -0
- package/skills/aimship/references/stages/requirements.md +4 -0
- package/skills/aimship/references/stages/review.md +2 -0
- package/skills/aimship/references/stages/scope.md +4 -0
- package/skills/aimship/references/stages/tech-design.md +6 -2
- package/skills/aimship/references/stages/test-design.md +5 -1
- package/skills/aimship/references/templates/plan.md +1 -0
- package/skills/aimship/references/templates/prd.md +2 -0
- package/skills/aimship/references/templates/scope.md +2 -0
- package/skills/aimship/references/templates/tech-design.md +1 -0
- package/skills/aimship/references/templates/testing.md +1 -0
package/docs/guide.md
CHANGED
|
@@ -2,276 +2,276 @@
|
|
|
2
2
|
|
|
3
3
|
[中文](guide.zh-CN.md) · [README](../README.md)
|
|
4
4
|
|
|
5
|
-
This guide
|
|
6
|
-
|
|
7
|
-
[Install](#install) · [Host setup](#hosts) · [Start](#start) · [Documents and stages](#artifacts) · [Review and changes](#changes) · [Continue](#continue) · [Parallel work](#parallel) · [Update](#update) · [Uninstall](#uninstall) · [Troubleshoot](#troubleshoot) · [Completion](#completion)
|
|
5
|
+
This guide explains what to provide, how the agent proceeds and where to find results in common situations. You do not need to memorize stage names or fixed prompts.
|
|
8
6
|
|
|
9
7
|
<a id="install"></a>
|
|
10
|
-
|
|
8
|
+
If Aimship is not installed yet, start with the README's [installation instructions](../README.md#install).
|
|
11
9
|
|
|
12
|
-
|
|
10
|
+
[Select Aimship](#hosts) · [Start from your situation](#start) · [Proceed and review](#review) · [Progress and results](#results) · [Changing requirements](#changes) · [Sessions and continuation](#continue) · [Parallel work](#parallel) · [Complete delivery](#completion) · [Usage problems](#troubleshoot)
|
|
13
11
|
|
|
14
|
-
|
|
12
|
+
<a id="hosts"></a>
|
|
13
|
+
<a id="1-select-aimship-in-your-host"></a>
|
|
14
|
+
<a id="1-select-aimship-in-your-ai-development-tool"></a>
|
|
15
|
+
## 1. Select Aimship in your AI tool
|
|
15
16
|
|
|
16
|
-
|
|
17
|
-
npx aimship@preview install --host codex
|
|
18
|
-
```
|
|
17
|
+
After installation, open a new tool session and select Aimship:
|
|
19
18
|
|
|
20
|
-
|
|
19
|
+
| AI tool | How to select it | If it is missing |
|
|
20
|
+
| --- | --- | --- |
|
|
21
|
+
| Codex | Choose Aimship in the Skill selector; use `$aimship` in CLI | Start a new conversation or restart the CLI; restart the app if the list is stale |
|
|
22
|
+
| Cursor | Use `/aimship` | Start a new agent session and inspect Customize → Skills; restart Cursor if stale |
|
|
23
|
+
| Claude Code | Use `/aimship` | Start a new session and inspect the slash-command list; restart Claude Code if stale |
|
|
21
24
|
|
|
22
|
-
|
|
23
|
-
npx aimship@preview install --host codex --host claude-code
|
|
24
|
-
```
|
|
25
|
+
Each tool needs its own login, available model and access to delivery materials and relevant code repositories. Grant access when an operation needs it. Delivery materials are stored separately; code stays in its existing repository.
|
|
25
26
|
|
|
26
|
-
|
|
27
|
+
AI tool integrations are experimental: actual Skill discovery, directory access and continuation across AI tools remain unverified. Healthy installation files do not prove that a tool loaded the Skill. Codex and Cursor share an entry, and compatible tools may discover entries in other locations; inspect paths and versions if duplicates appear, preserving unrelated or customized content. See the official [Cursor documentation](https://cursor.com/docs/skills) and [Codex skill locations](https://learn.chatgpt.com/docs/build-skills) for tool behavior.
|
|
27
28
|
|
|
28
|
-
|
|
29
|
+
<a id="start"></a>
|
|
30
|
+
<a id="describe-the-work-and-its-endpoint"></a>
|
|
31
|
+
## 2. Start from your current situation
|
|
29
32
|
|
|
30
|
-
|
|
33
|
+
### Starting with an idea
|
|
31
34
|
|
|
32
|
-
|
|
33
|
-
node bin/aimship.mjs install --host codex
|
|
34
|
-
```
|
|
35
|
+
Describe the problem, who it affects, the expected change and known constraints. Include screenshots, discussion notes or references if available; a complete PRD is not required.
|
|
35
36
|
|
|
36
|
-
|
|
37
|
+
The agent clarifies gaps that affect scope and acceptance, organizes requirements, and proposes the stages and execution order. After you confirm the goal and important tradeoffs, work proceeds. Requirements and acceptance criteria are usually recorded in `prd.md`; open `status.md` for current progress.
|
|
37
38
|
|
|
38
|
-
|
|
39
|
-
npx --offline file:./aimship-VERSION.tgz install --host codex
|
|
40
|
-
```
|
|
39
|
+
### Working from an existing PRD, prototype or other materials
|
|
41
40
|
|
|
42
|
-
|
|
41
|
+
Provide material locations, the versions to adopt and relevant code locations. If only part of the material applies, identify that scope. Mention known gaps when materials are incomplete.
|
|
43
42
|
|
|
44
|
-
|
|
43
|
+
The agent checks access and coverage of the delivery goal. When adopting an authoritative PRD or prototype, it preserves the originals and records the adopted scope, gaps and decisions in `scope.md`; scattered references instead inform authored requirements. Covered interactions are reused, with uncovered changes developed as needed. Follow the requirements document and its source links to see what was adopted and which decisions remain.
|
|
45
44
|
|
|
46
|
-
|
|
47
|
-
| --- | --- |
|
|
48
|
-
| `~/.aimship/` | Fixed software releases, configuration and custom content |
|
|
49
|
-
| `~/.aimship/bin/aimship.mjs` | Stable launcher for the active installed release |
|
|
50
|
-
| `~/Aimship/<request>/` | One delivery's documents and internal `.aimship/` records |
|
|
51
|
-
| Your existing repositories | Code, branches and worktrees; linked from delivery state |
|
|
52
|
-
|
|
53
|
-
Installation does not create a delivery or move code. Select an initial material root with `--data-root` if needed; later installs retain existing configuration. There is no language setting or per-project installation. The installer keeps the active release and at most one ordinary recovery release, preserving changed or unowned files.
|
|
54
|
-
|
|
55
|
-
For an isolated trial, place the supplied tarball in the current directory, replace `VERSION`, then run:
|
|
56
|
-
|
|
57
|
-
```sh
|
|
58
|
-
trial=$(mktemp -d)
|
|
59
|
-
trial=$(cd "$trial" && pwd -P)
|
|
60
|
-
npx --yes --offline --cache "$trial/npm-cache" file:./aimship-VERSION.tgz install --home "$trial/home" --host codex
|
|
61
|
-
node "$trial/home/.aimship/bin/aimship.mjs" --version
|
|
62
|
-
node "$trial/home/.aimship/bin/aimship.mjs" status
|
|
63
|
-
node "$trial/home/.aimship/bin/aimship.mjs" install --host cursor
|
|
64
|
-
node "$trial/home/.aimship/bin/aimship.mjs" uninstall --host cursor
|
|
65
|
-
node "$trial/home/.aimship/bin/aimship.mjs" uninstall
|
|
66
|
-
```
|
|
45
|
+
### Changing a feature, fixing a defect or refactoring
|
|
67
46
|
|
|
68
|
-
|
|
47
|
+
Provide the relevant repository and feature location, expected behavior, current problems and behavior that must be preserved. For a defect, include available reproduction steps, errors or logs; for refactoring, explain the technical goal and external behavior that must remain unchanged.
|
|
69
48
|
|
|
70
|
-
|
|
71
|
-
## 2. Select Aimship in your host
|
|
49
|
+
The agent examines the implementation, confirms requirements and technical constraints, and arranges design, implementation, review and verification. Ordinary debugging stays within the current work; a significant unknown requiring independent investigation leads to an arrangement change. `plan.md` tracks implementation, while `review.md` and `testing.md` record review and actual verification results.
|
|
72
50
|
|
|
73
|
-
|
|
74
|
-
| --- | --- | --- | --- |
|
|
75
|
-
| Codex | `~/.agents/skills/aimship/` | Select Aimship; `$aimship` in CLI | Start a new conversation or restart the CLI; check the actual skill selector. Restart the app if stale. |
|
|
76
|
-
| Cursor | Same `.agents/skills/aimship/` entry | `/aimship` | Start a new agent session and inspect Customize → Skills; restart if stale. |
|
|
77
|
-
| Claude Code | `~/.claude/skills/aimship/` | `/aimship` | Start a new session and inspect slash-command discovery; restart if stale. |
|
|
51
|
+
Preserve adopted versions of external material; a URL alone may not retain a version, and access gaps must be explicit. An existing editable PRD may be reused when you explicitly commission its maintenance and it fully states this scope, authorization and endpoint. Earlier authorship alone does not permit changing an adopted original.
|
|
78
52
|
|
|
79
|
-
|
|
53
|
+
In all these situations, the agent preserves the original request and maintains delivery records. Important business, scope, compatibility, cost or data decisions remain yours; routine technical decisions stay within your authorization. An unanswered decision is not treated as approval, and dependent work waits for resolution.
|
|
80
54
|
|
|
81
|
-
|
|
55
|
+
<a id="review"></a>
|
|
56
|
+
<a id="review-documents-and-continue"></a>
|
|
57
|
+
## 3. Proceed and review
|
|
82
58
|
|
|
83
|
-
|
|
59
|
+
The standard sequence is requirements and acceptance criteria → technical design with applicable interface/SQL/interaction artifacts → test cases → implementation plan → implementation batches with batch review → overall review → verification → delivery acceptance. The agent organizes this sequence without asking you to select every core stage. Unrelated artifacts are not created; existing formal material is inspected before adoption, which does not itself constitute approval.
|
|
84
60
|
|
|
85
|
-
|
|
86
|
-
node "$HOME/.aimship/bin/aimship.mjs" install --host cursor
|
|
87
|
-
node "$HOME/.aimship/bin/aimship.mjs" --version
|
|
88
|
-
node "$HOME/.aimship/bin/aimship.mjs" status
|
|
89
|
-
```
|
|
61
|
+
After drafting and self-checking each document that needs your review, the agent shows the current stage status, document entry and review focus. Explicitly approve it or raise questions. Discussion, silence and requests to see results are not approval; revisions are self-checked and presented again. No next-stage continuation prompt is issued while review is pending.
|
|
90
62
|
|
|
91
|
-
|
|
63
|
+
After explicit approval, the agent records the decision and document version, saves progress and next work, checks the save result, and then suggests the next action in the same handling of your message. You need not separately confirm saving or the prompt; failed saves are reported honestly. Within a suggested session group, the next item starts directly. At a group boundary, the agent suggests a new session and provides a short entry without executing the next group in that response. Say “continue in this session” to proceed without another approval. See [session grouping suggestions](#continue).
|
|
92
64
|
|
|
93
|
-
|
|
94
|
-
<a id="describe-the-work-and-its-endpoint"></a>
|
|
95
|
-
## 3. Delivery goals and authorization
|
|
65
|
+
If you explicitly exclude test cases and testing, the agent explains and records that scope once, completes the authorized development and review, and hands over an **untested partial result**. It does not quietly add excluded work or repeatedly persuade you. Finishing that scope is not standard complete delivery or a passing verification result. Document approval remains separate from final delivery acceptance.
|
|
96
66
|
|
|
97
|
-
|
|
67
|
+
Authorized implementation, batch checks/repairs and retests can proceed. Review or test findings first lead to repairs or the existing change flow. New material decisions and production actions still need their corresponding authorization.
|
|
98
68
|
|
|
99
|
-
>
|
|
69
|
+
<a id="results"></a>
|
|
70
|
+
<a id="3-inspect-progress-and-results"></a>
|
|
71
|
+
## 4. Inspect progress and results
|
|
100
72
|
|
|
101
|
-
|
|
73
|
+
Start with the delivery's **`status.md`** for the current stage, pending documents, review status, blockers, next stage and artifact links. Read verification conclusions alongside the tested version, environment and evidence. Checks lacking accounts, tools or environments remain blocked or unexecuted rather than passing.
|
|
102
74
|
|
|
103
|
-
|
|
75
|
+
<a id="delivery-structure"></a>
|
|
76
|
+
### Delivery structure and documents
|
|
104
77
|
|
|
105
|
-
|
|
78
|
+
By default, each request has its own delivery directory under `~/Aimship/`, while code stays in its existing repositories.
|
|
106
79
|
|
|
107
|
-
|
|
108
|
-
<a id="keep-only-useful-artifacts"></a>
|
|
109
|
-
## 4. Documents, stages and generation rules
|
|
80
|
+
The tree below lists delivery artifacts and their purposes. Files follow the agreed delivery scope and actual artifact conditions; unrelated work produces no empty documents. `prd.md` and `scope.md` are alternative requirement entries, not two files required for every delivery.
|
|
110
81
|
|
|
111
|
-
|
|
82
|
+
```text
|
|
83
|
+
~/Aimship/
|
|
84
|
+
├── 20261023-order-export/ # One request, one delivery folder
|
|
85
|
+
│ ├── status.md # Generated overview and reading entry
|
|
86
|
+
│ ├── prd.md # Authored requirements, scope and acceptance
|
|
87
|
+
│ ├── scope.md # Used instead of PRD when adopting authoritative inputs
|
|
88
|
+
│ ├── tech-design.md # Architecture, changes, data, risks and requirement coverage
|
|
89
|
+
│ ├── plan.md # Implementation batches, tasks and actual execution
|
|
90
|
+
│ ├── testing.md # Test cases, coverage, runs and retest results
|
|
91
|
+
│ ├── review.md # Batch/overall reviews, findings and follow-up
|
|
92
|
+
│ ├── handoff.md # Delivered result, usage, validation and remaining work
|
|
93
|
+
│ ├── diagnosis.md # Only for an independent investigation
|
|
94
|
+
│ ├── change-log.md # Meaningful changes, decisions and affected work
|
|
95
|
+
│ ├── openapi.yaml # New HTTP contract; reuse an existing authority when available
|
|
96
|
+
│ ├── database.sql # SQL for one database; multiple targets use database-<id>.sql
|
|
97
|
+
│ ├── prototype/ # Newly authored prototypes when required
|
|
98
|
+
│ │ └── index.html # Entry for an HTML prototype; its assets stay here
|
|
99
|
+
│ ├── source/ # Preserved original request and adopted input versions
|
|
100
|
+
│ │ ├── request.md # Original commission or source entry
|
|
101
|
+
│ │ └── … # External PRD, prototype, screenshots and other inputs
|
|
102
|
+
│ └── .aimship/ # Managed state and supporting evidence
|
|
103
|
+
│ ├── state.json # Stages, references, versions and repository/worktree links
|
|
104
|
+
│ ├── state.previous.json # Previous state for recovery after writes
|
|
105
|
+
│ ├── view.json # Metadata for the generated status view
|
|
106
|
+
│ └── evidence/ # Evidence retained when needed
|
|
107
|
+
└── 20261024-another-request/ # Independent request and progress
|
|
108
|
+
```
|
|
112
109
|
|
|
113
|
-
|
|
110
|
+
Formal documents are directly in the request folder. `source/` preserves adopted originals; `.aimship/` holds internal records. The software itself is installed separately in `~/.aimship/`.
|
|
114
111
|
|
|
115
|
-
|
|
116
|
-
| --- | --- | --- |
|
|
117
|
-
| An authoritative PRD/prototype is supplied for adoption | `scope.md` records adopted versions, scope, gaps, decisions and acceptance; originals remain unchanged | Reuse covered interactions; create a prototype for uncovered interaction changes within the commissioned endpoint |
|
|
118
|
-
| An idea, discussion, screenshots or scattered references | Author `prd.md`, including scope and acceptance | Create a prototype when the commissioned work changes interactions and existing material does not cover them |
|
|
119
|
-
| Technical refactoring or a known-cause fix | Author `prd.md` describing the technical goal, boundaries, behavior constraints and acceptance | No prototype when there is no interaction change |
|
|
120
|
-
| Independent investigation, review-only or verification-only | PRD/Scope defines that commission and its endpoint | Do not invent a future implementation or prototype |
|
|
112
|
+
Filenames, outlines and identifier rules come from shared templates. Requirements and acceptance criteria link to implementation tasks, reviews and versioned test cases/results. The [document details](#document-details) explain when each artifact is produced and what it contains.
|
|
121
113
|
|
|
122
|
-
|
|
114
|
+
<a id="changes"></a>
|
|
115
|
+
<a id="review-verify-and-change"></a>
|
|
116
|
+
<a id="4-requirements-change-during-delivery"></a>
|
|
117
|
+
## 5. Requirements change during delivery
|
|
123
118
|
|
|
124
|
-
|
|
119
|
+
Explain what changed, why, and what should remain. If you edited a formal document, identify the location so the agent can reconcile its meaning.
|
|
125
120
|
|
|
126
|
-
|
|
121
|
+
The agent assesses the impact on scope, design, implementation and verification, records decisions, and updates affected documents and work arrangements. It brings necessary tradeoffs to you while other authorized work continues. Adopted originals are preserved.
|
|
127
122
|
|
|
128
|
-
|
|
123
|
+
A material change to an approved document returns it to review and holds dependent work until the review is resolved. Earlier approvals and results remain as history; an old approval cannot authorize the revised content. Work resumes in dependency order after re-review. Unaffected work is retained, and formatting or typo fixes do not require full re-review.
|
|
129
124
|
|
|
130
|
-
|
|
131
|
-
| --- | --- | --- |
|
|
132
|
-
| `frame` | The problem or intended result needs clarification | Goal/background section of PRD/Scope: problem, outcome, non-goals and assumptions |
|
|
133
|
-
| `requirements` | Requirements need authoring or adoption | `prd.md`: goals, scope, requirements, states, acceptance and arrangement; or `scope.md`: source adoption, scope, exclusions, decisions, acceptance and arrangement |
|
|
134
|
-
| `scope` | Commission boundaries need explicit resolution | Update PRD scope or Scope goals/boundaries; no second requirements document |
|
|
135
|
-
| `prototype` | Required interaction changes are not covered by existing material | New HTML at `prototype/index.html` with related assets; other agreed formats or reused entries are registered |
|
|
136
|
-
| `diagnose` | An independent investigation is explicitly arranged | `diagnosis.md`: goal, symptoms, environment, evidence, causes, unknowns and conclusion |
|
|
137
|
-
| `tech-design` | Technical solution needs designing | `tech-design.md`: basis, architecture, modules, data/contracts, errors, risks and requirement coverage; required SQL is ready before this stage finishes |
|
|
138
|
-
| `contract` | A contract needs creating or changing | HTTP: `openapi.yaml` or the registered engineering authority; record an agreed format for non-HTTP contracts |
|
|
139
|
-
| `plan` | Before any implementation, including one small batch | `plan.md`: basis, batches, tasks, validation approach, execution section and remaining work |
|
|
140
|
-
| `test-design` | Test cases need authoring | `testing.md`: basis, environment, cases/assertions and requirement/acceptance coverage |
|
|
141
|
-
| `implement` | Execute the accepted plan | Code in its repositories; actual task status, objects and deviations in the same `plan.md` |
|
|
142
|
-
| `review` | Review a batch, the integrated result or a review-only commission | `review.md`: review basis, each review's scope/findings/resolution and conclusion |
|
|
143
|
-
| `verify` | Execute versioned cases after the required review, or a verification-only commission | Append execution batches/RUNs, actual results/evidence, retests and conclusion to the same `testing.md` |
|
|
144
|
-
| `handoff` | Deliver the agreed endpoint | `handoff.md`: goal, artifacts, usage, review/verification results, limits and completion/acceptance/integration outcomes |
|
|
125
|
+
Meaningful changes and their impact are recorded in `change-log.md`; see `status.md` for next steps. Do not edit `status.md` to change requirements or record acceptance: it is a generated view. Any manual edits need preserving before the agent reconciles and regenerates it.
|
|
145
126
|
|
|
146
|
-
|
|
127
|
+
<a id="continue"></a>
|
|
128
|
+
<a id="continue-in-another-conversation"></a>
|
|
129
|
+
<a id="5-resume-after-a-pause-or-in-another-session"></a>
|
|
130
|
+
<a id="6-resume-after-a-pause-or-in-another-session"></a>
|
|
131
|
+
## 6. Session arrangements and continuing work
|
|
147
132
|
|
|
148
|
-
|
|
133
|
+
### Session grouping suggestions
|
|
149
134
|
|
|
150
|
-
|
|
135
|
+
The following arrangement is based on experience from actual projects and can be adjusted to task size. At delivery creation or requirements confirmation, the agent records applicable suggested groups in state and shows them in `status.md`:
|
|
151
136
|
|
|
152
|
-
|
|
|
137
|
+
| Work | Session arrangement |
|
|
153
138
|
| --- | --- |
|
|
154
|
-
|
|
|
155
|
-
|
|
|
156
|
-
|
|
|
157
|
-
|
|
|
158
|
-
|
|
|
139
|
+
| Requirements / Scope | One session |
|
|
140
|
+
| Technical design, SQL and interface documents | One shared session |
|
|
141
|
+
| Test-case design | One session |
|
|
142
|
+
| Implementation plan | One session |
|
|
143
|
+
| Implementation | One session per implementation batch, including that batch's agent review |
|
|
144
|
+
| Overall review | One session |
|
|
145
|
+
| Test execution | One session per test batch |
|
|
159
146
|
|
|
160
|
-
|
|
147
|
+
This is practical experience, not a required split or a stage completion condition. Adjust it to the task's size, volume of materials and accumulated context. Assess any combined arrangement in actual use. Sharing a session for technical design, SQL and interfaces still requires the agreed document order: review technical design first, then each applicable interface/SQL document individually. A shared session does not bypass approval.
|
|
161
148
|
|
|
162
|
-
|
|
149
|
+
Implementation batches and test batches serve different purposes. Test batches follow the verification arrangement and need not correspond one-to-one with implementation batches; this does not require testing after every implementation batch. A new session alone does not guarantee independent judgment or quality. Each new session still needs the relevant complete formal documents, saved state and actual artifacts, not just a brief chat summary.
|
|
163
150
|
|
|
164
|
-
###
|
|
151
|
+
### Arrange the next session and hand off
|
|
165
152
|
|
|
166
|
-
|
|
153
|
+
At a suggested boundary, the agent first confirms that approval, results and state were saved, then reports current results and next work, suggests a new session, and provides one copyable entry using the actual delivery directory:
|
|
167
154
|
|
|
168
|
-
|
|
169
|
-
| --- | --- |
|
|
170
|
-
| `REQ-001`, `AC-001` | Requirement and acceptance criterion |
|
|
171
|
-
| `B-001`, `TASK-001` | Implementation batch and task |
|
|
172
|
-
| `PAGE-001`, `Q-001` | Prototype page and tracked question |
|
|
173
|
-
| `TC-001`, `RUN-001` | Test case and actual verification run |
|
|
174
|
-
| `REV-001`, `CHG-001` | Review and meaningful change |
|
|
155
|
+
> Use Aimship to continue delivery <actual directory>; first read the current state and relevant formal documents, then continue the recorded work.
|
|
175
156
|
|
|
176
|
-
|
|
157
|
+
You do not need to repeat a session-switch instruction with each approval or separately confirm saving and prompt generation. Say “continue in this session” to proceed. Grouping is a context suggestion, not an approval or blocker. Final handoff has no unnecessary next-stage entry. Ask for a complete prompt when needed; the default is not a long prompt at every stage or a separate prompt/handoff file.
|
|
177
158
|
|
|
178
|
-
|
|
159
|
+
Aimship itself does not create sessions. After the current session confirms saving and stops writing, open a new session in your AI tool, select Aimship and paste the entry. The new session must uniquely locate the same delivery and inspect actual state, document approval versions, relevant complete formal documents, artifacts and unfinished operations before acting. A trustworthy binding avoids repeated path questions; a missing or ambiguous binding requires a directory or candidate selection, never a guessed latest delivery. Saying “continue next stage” or copying an old prompt grants no approval; a pending draft remains pending across sessions.
|
|
179
160
|
|
|
180
|
-
|
|
161
|
+
Keep one writing session per delivery. Code locations and access permissions must remain available; switching sessions cannot bypass reviews or affected-work stops. Progress stays in the same `status.md`, without copying the entire chat.
|
|
181
162
|
|
|
182
|
-
|
|
163
|
+
Official CLI documentation checked on 2026-10-25 describes [`/new`](https://developers.openai.com/codex/cli/slash-commands) for Codex, [`/new-chat`](https://cursor.com/docs/cli/reference/slash-commands) for Cursor CLI, and [`/clear`](https://code.claude.com/docs/en/interactive-mode#command-history) for Claude Code to start a fresh chat/session. Check the command list of your installed CLI version; these are documentation checks, not a claim of testing each tool. They differ from simply redrawing the screen or compacting context. Save and stop the current writer first.
|
|
183
164
|
|
|
184
|
-
|
|
185
|
-
<a id="review-verify-and-change"></a>
|
|
186
|
-
## 5. Results and change management
|
|
165
|
+
### Handle interruptions and version changes
|
|
187
166
|
|
|
188
|
-
|
|
167
|
+
After an unexpected interruption, have the agent check completed operations before repeating writes or other actions with side effects. If a repository moved, provide its new location so the agent can verify its identity and update the association. State conflicts or progress-view problems need reconciliation or repair, not forced overwrites.
|
|
189
168
|
|
|
190
|
-
|
|
169
|
+
After a software upgrade, an old session may retain old rules. Save work, then have the agent reconcile the current version and delivery records at a stable boundary; start a new session if context cannot refresh reliably. Older delivery formats require explicit migration, rule adoption and document reconciliation before work continues; unknown formats remain read-only. Originals and historical results are preserved without inventing work that was never performed or treating old completion records as approval. The [CLI protocol](cli.md) provides recovery details for the agent.
|
|
191
170
|
|
|
192
|
-
|
|
171
|
+
<a id="parallel"></a>
|
|
172
|
+
<a id="work-on-two-requests-at-once"></a>
|
|
173
|
+
<a id="6-progress-several-deliveries-at-once"></a>
|
|
174
|
+
## 7. Progress several deliveries at once
|
|
193
175
|
|
|
194
|
-
|
|
195
|
-
<a id="continue-in-another-conversation"></a>
|
|
196
|
-
## 6. Progress checkpoints and session continuation
|
|
176
|
+
Use a separate delivery directory for each request, with one writing session per delivery. Tell the agent about known shared code, interfaces, databases or test environments.
|
|
197
177
|
|
|
198
|
-
|
|
178
|
+
While one delivery changes code, another can perform read-only analysis. Before both change the same code, arrange sequential implementation or separate checkouts/worktrees, reusing existing isolation when available. The agent checks overlap against accessible known delivery records and documents coordination in the plan. Unknown or stale records and work outside Aimship limit this check.
|
|
199
179
|
|
|
200
|
-
|
|
180
|
+
Read each delivery's own progress and results. Completing a branch does not complete integration; Aimship provides no global lock, automatic agent scheduling, automatic worktree creation or automatic merge.
|
|
201
181
|
|
|
202
|
-
|
|
182
|
+
<a id="completion"></a>
|
|
183
|
+
<a id="decide-when-work-is-done"></a>
|
|
184
|
+
<a id="7-complete-a-delivery"></a>
|
|
185
|
+
## 8. Complete a delivery
|
|
203
186
|
|
|
204
|
-
|
|
187
|
+
Review artifact locations, usage instructions, review and verification conclusions, remaining issues and next steps in the handoff. Compare them with the original goal when deciding whether to accept the result.
|
|
205
188
|
|
|
206
|
-
|
|
207
|
-
<a id="work-on-two-requests-at-once"></a>
|
|
208
|
-
## 7. Parallel deliveries
|
|
189
|
+
The agent records goal completion, user acceptance, merge and deployment separately. Asking for a preview does not shorten the goal; if you explicitly end early, the handoff preserves the original goal and unfinished work.
|
|
209
190
|
|
|
210
|
-
|
|
191
|
+
Standard complete delivery needs evidence for the main sequence, required document approvals, passing batch/overall reviews, independent verification and final acceptance. `status.md` distinguishes standard completeness from completion of the agreed scope and user acceptance. Tools check records; they cannot independently prove execution or semantic quality. An explicitly limited result can be finished and handed over as partial scope; untested work is labeled untested. Historical outcomes and acceptance remain intact, initially unassessed under the new standard. Inspect evidence and explicitly adopt the new rules before continuing, without inventing historical approvals or tests.
|
|
211
192
|
|
|
212
|
-
|
|
193
|
+
Small later corrections can continue the same delivery while preserving its earlier completion record. A new goal or substantial redesign starts a related delivery.
|
|
213
194
|
|
|
214
|
-
|
|
195
|
+
<a id="troubleshoot"></a>
|
|
196
|
+
<a id="8-problems-during-use"></a>
|
|
197
|
+
## 9. Problems during use
|
|
215
198
|
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
199
|
+
| Situation | What to do |
|
|
200
|
+
| --- | --- |
|
|
201
|
+
| Materials or code cannot be accessed | Grant the required directory access in the current tool and identify the failed operation; do not move materials to bypass restrictions |
|
|
202
|
+
| The progress page differs from actual results | Have the agent inspect current records and files, preserve manual edits and regenerate the progress page |
|
|
203
|
+
| A formal document changed outside the session | Identify the changes and have the agent assess their meaning and effect on subsequent work |
|
|
204
|
+
| An old delivery cannot continue | Have the agent check format migration, rule adoption and document reconciliation, preserving historical results and explaining blockers |
|
|
205
|
+
| Aimship is missing, or installation/version problems occur | See [installation and upgrade problems](../README.md#installation-troubleshooting) in the README |
|
|
219
206
|
|
|
220
|
-
For the
|
|
207
|
+
For a bug report, include the tool and Aimship versions, the operation, expected and actual results, and minimal reproducible materials. Redact credentials, personal paths and business data before submitting to [GitHub Issues](https://github.com/clsx/aimship/issues).
|
|
221
208
|
|
|
222
|
-
|
|
223
|
-
npx aimship@preview install
|
|
224
|
-
```
|
|
209
|
+
## Related references
|
|
225
210
|
|
|
226
|
-
|
|
211
|
+
<a id="artifacts"></a>
|
|
212
|
+
<a id="keep-only-useful-artifacts"></a>
|
|
213
|
+
See the [document details](#document-details) for generation conditions, stage outputs, outlines and identifier rules. The agent maintains these as work progresses; you do not need to learn them all before starting.
|
|
227
214
|
|
|
228
|
-
|
|
215
|
+
<a id="update"></a>
|
|
216
|
+
<a id="update-or-stop-using-aimship"></a>
|
|
217
|
+
For software upgrades, adding tools, version queries and installation health checks, see the [README](../README.md#update).
|
|
229
218
|
|
|
230
|
-
|
|
219
|
+
<a id="uninstall"></a>
|
|
220
|
+
For tool disconnection or full uninstallation, see the [README](../README.md#uninstall). Source development and isolated validation belong in [Contributing](../CONTRIBUTING.md).
|
|
231
221
|
|
|
232
|
-
|
|
222
|
+
<a id="document-details"></a>
|
|
223
|
+
## Appendix: document details
|
|
233
224
|
|
|
234
|
-
|
|
235
|
-
## 9. Host disconnection and uninstallation
|
|
225
|
+
Use the preceding sections for everyday work. This appendix covers stage outputs, SQL and traceability; file locations follow the [delivery directory](#delivery-structure).
|
|
236
226
|
|
|
237
|
-
|
|
227
|
+
<a id="choose-the-requirement-authority"></a>
|
|
228
|
+
See [starting work](#start) for source adoption. PRD and Scope are alternative requirement authorities, not duplicate documents to create by default.
|
|
238
229
|
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
```
|
|
230
|
+
<a id="stage-outputs-and-content"></a>
|
|
231
|
+
### Stage outputs
|
|
242
232
|
|
|
243
|
-
|
|
233
|
+
This is an internal responsibility/file mapping for understanding artifacts, not a menu of arbitrary stages to select. See [progress and review](#review) for the standard sequence and limited scope. Sharing plan/testing does not complete stages together, and file existence does not establish completion.
|
|
244
234
|
|
|
245
|
-
|
|
235
|
+
| Stage | When used | Output and content |
|
|
236
|
+
| --- | --- | --- |
|
|
237
|
+
| `frame` | The problem or intended result needs clarification | Goal/background section of PRD/Scope: problem, outcome, non-goals and assumptions |
|
|
238
|
+
| `requirements` | Requirements need authoring or adoption | `prd.md`: goals, scope, requirements, states, acceptance and arrangement; or `scope.md`: source adoption, scope, exclusions, decisions, acceptance and arrangement |
|
|
239
|
+
| `scope` | Commission boundaries need explicit resolution | Update PRD scope or Scope goals/boundaries; no second requirements document |
|
|
240
|
+
| `prototype` | Required interaction changes are not covered by existing material | New HTML at `prototype/index.html` with related assets; other agreed formats or reused entries are registered |
|
|
241
|
+
| `diagnose` | An independent investigation is explicitly arranged | `diagnosis.md`: goal, symptoms, environment, evidence, causes, unknowns and conclusion |
|
|
242
|
+
| `tech-design` | Technical solution needs designing | `tech-design.md`: basis, architecture, modules, data/contracts, errors, risks and requirement coverage; SQL is produced and reviewed in contract after this design is approved |
|
|
243
|
+
| `contract` | Interfaces or database changes need formal artifacts | HTTP: `openapi.yaml` or the registered authority; agreed non-HTTP format; independent SQL per target, reviewed individually |
|
|
244
|
+
| `test-design` | Test cases need authoring | `testing.md`: basis, environment, cases/assertions and requirement/acceptance coverage |
|
|
245
|
+
| `plan` | Before any implementation, including one small batch | `plan.md`: basis, batches, tasks, validation approach, execution section and remaining work |
|
|
246
|
+
| `implement` | Execute the accepted plan | Code in its repositories; actual task status, objects and deviations in the same `plan.md` |
|
|
247
|
+
| `review` | Review a batch, the integrated result or a review-only commission | `review.md`: review basis, each review's scope/findings/resolution and conclusion |
|
|
248
|
+
| `verify` | Execute versioned cases after the required review, or a verification-only commission | Append execution batches/RUNs, actual results/evidence, retests and conclusion to the same `testing.md` |
|
|
249
|
+
| `handoff` | Deliver the agreed endpoint | `handoff.md`: goal, artifacts, usage, review/verification results, limits and completion/acceptance/integration outcomes |
|
|
246
250
|
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
```
|
|
251
|
+
<a id="sql-changes-and-progress"></a>
|
|
252
|
+
### SQL and engineering versions
|
|
250
253
|
|
|
251
|
-
|
|
254
|
+
SQL identifies the target, dialect, version/schema basis and execution conditions, and links ordered statements to requirements/design. It is prepared and individually reviewed in contract after technical design approval and before test cases. A Markdown SQL snippet or migration reference does not replace this deliverable. Generating SQL does not authorize executing it or changing a repository's migration mechanism.
|
|
252
255
|
|
|
253
|
-
|
|
254
|
-
|
|
256
|
+
Existing engineering HTTP contracts remain authoritative; avoid a second competing copy. Project current and target versions are recorded in PRD/Scope with their engineering source and observation basis; an unspecified version remains unspecified. `plan.md` records actual changes, while review and test results identify the exact commit/build or uncommitted content. Each repository has its own version and object references. These differ from Aimship’s rules version, state schema and save revision. The handoff records final code objects and actual merge/release status; a target version does not establish publication.
|
|
257
|
+
|
|
258
|
+
<a id="fixed-outlines-and-traceable-identifiers"></a>
|
|
259
|
+
### Outlines and traceable identifiers
|
|
255
260
|
|
|
256
|
-
|
|
261
|
+
New documents follow [shared templates and rules](../skills/aimship/references/document-patterns.md). Section order and stable anchors are retained; visible headings can be translated. Inapplicable sections explain why. Short tasks use the same outline, with shorter content. Unselected stages do not produce empty documents, and there is no arbitrary small-task merging.
|
|
262
|
+
|
|
263
|
+
| Identifier | Meaning |
|
|
257
264
|
| --- | --- |
|
|
258
|
-
|
|
|
259
|
-
|
|
|
260
|
-
|
|
|
261
|
-
|
|
|
262
|
-
|
|
|
263
|
-
| Unexpected version | Query the stable installed launcher. A source checkout or an older release's CLI can report a different version; reload the current binding. |
|
|
264
|
-
| Package/version unavailable or authentication failure | Confirm the package, exact version and registry. A failed download is not a completed installation. Keep credentials out of reports. |
|
|
265
|
-
| Stale or manually edited `status.md` | Ask the agent to read current state/documents, preserve edits and explicitly regenerate the view. Do not overwrite state from the view. |
|
|
266
|
-
| A formal document changed outside the workflow | Reconcile its meaning and affected work; matching state/view revisions do not prove that document content is unchanged. |
|
|
267
|
-
| An old delivery cannot advance | Have the agent inspect migration, rule adoption and document reconciliation separately. Preserve historical results and report unresolved blockers. |
|
|
268
|
-
|
|
269
|
-
For a bug report, include the Aimship version, host/version, exact command or operation, expected/actual result and a minimal synthetic reproduction. Redact credentials and private paths/data. Use [GitHub Issues](https://github.com/clsx/aimship/issues); contributors can follow [CONTRIBUTING](../CONTRIBUTING.md).
|
|
265
|
+
| `REQ-001`, `AC-001` | Requirement and acceptance criterion |
|
|
266
|
+
| `B-001`, `TASK-001` | Implementation batch and task |
|
|
267
|
+
| `PAGE-001`, `Q-001` | Prototype page and tracked question |
|
|
268
|
+
| `TC-001`, `RUN-001` | Test case and actual verification run |
|
|
269
|
+
| `REV-001`, `CHG-001` | Review and meaningful change |
|
|
270
270
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
271
|
+
Each series starts at `001` and advances beyond its historical maximum, including retired items; three digits are the minimum width. An ID is never reused for a different obligation. Within a namespace and version, an identity has one effective definition; other documents reference it. Classification or layout changes retain the ID, while splits/merges create new IDs linked to the originals.
|
|
272
|
+
|
|
273
|
+
References connect requirements/acceptance to design, tasks, code objects, reviews, case versions and actual runs. These relationships may be many-to-many: `REQ-001` and `TC-001` are not related merely because their numbers match. Shared rules, permissions and quality requirements receive independent identities when independently testable. External IDs retain their spelling and source/version namespace; sources without IDs receive local mappings to their original locations. Changed case meaning gets a new version; earlier failures and their case/code versions remain traceable.
|
|
274
274
|
|
|
275
|
-
|
|
275
|
+
For example: `REQ-001 → AC-002 → TC-004@1 → RUN-003` records the explicit requirement-to-result relationship. A RUN also identifies the tested code/build and evidence; the case ID alone does not prove execution.
|
|
276
276
|
|
|
277
|
-
|
|
277
|
+
The tools check structure, references and basic coverage. The agent must still assess whether the content and assertions actually satisfy the requirement; valid metadata alone is not proof.
|