aimship 0.1.0-preview.7 → 0.1.0-preview.8
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 +38 -1
- package/README.md +120 -58
- package/README.zh-CN.md +120 -58
- package/docs/cli.md +18 -2
- package/docs/guide.md +134 -201
- package/docs/guide.zh-CN.md +134 -201
- package/docs/installation.md +12 -8
- package/docs/reference.md +78 -0
- package/docs/reference.zh-CN.md +78 -0
- package/lib/approvals.mjs +153 -0
- package/lib/cli.mjs +4 -3
- package/lib/documents.mjs +5 -4
- package/lib/state.mjs +13 -7
- package/lib/view.mjs +6 -0
- package/package.json +1 -1
- package/skills/aimship/SKILL.md +1 -1
- package/skills/aimship/references/artifact-map.json +21 -12
- package/skills/aimship/references/core.md +5 -3
- package/skills/aimship/references/document-patterns.md +4 -2
- package/skills/aimship/references/document-review.md +28 -0
- package/skills/aimship/references/recovery.md +2 -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/plan.md +5 -1
- package/skills/aimship/references/stages/prototype.md +4 -0
- package/skills/aimship/references/stages/requirements.md +4 -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/tech-design.md +1 -0
- package/skills/aimship/references/templates/testing.md +1 -0
package/docs/guide.md
CHANGED
|
@@ -2,276 +2,209 @@
|
|
|
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
|
-
|
|
11
|
-
|
|
12
|
-
Requires **Node.js 22+ and npm**. Installation and tool behavior have been checked on macOS arm64 with Node 24 and 26; Node 22 and other operating systems remain unverified. Command examples use a POSIX shell.
|
|
13
|
-
|
|
14
|
-
### Published preview
|
|
15
|
-
|
|
16
|
-
```sh
|
|
17
|
-
npx aimship@preview install --host codex
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Choose `codex`, `cursor` or `claude-code`. To connect several hosts, repeat the option:
|
|
21
|
-
|
|
22
|
-
```sh
|
|
23
|
-
npx aimship@preview install --host codex --host claude-code
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
Confirm npm's package installation prompt. `@preview` selects the published preview channel; an exact published version, such as `@0.1.0-preview.7`, can be used instead. The preview channel is experimental and does not imply a stable release.
|
|
27
|
-
|
|
28
|
-
### Source or local package
|
|
29
|
-
|
|
30
|
-
From the Aimship source checkout:
|
|
31
|
-
|
|
32
|
-
```sh
|
|
33
|
-
node bin/aimship.mjs install --host codex
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
For a supplied tarball, replace `VERSION` with its actual version and run from the directory containing it:
|
|
8
|
+
If Aimship is not installed yet, start with the README's [installation instructions](../README.md#install).
|
|
37
9
|
|
|
38
|
-
|
|
39
|
-
npx --offline file:./aimship-VERSION.tgz install --host codex
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
These are alternative ways to run the same installer. No global npm install or administrator privilege is required. A local tarball requires a writable npm cache but no npm login. Use your real home only when you intend to install there.
|
|
43
|
-
|
|
44
|
-
### Installation and delivery locations
|
|
45
|
-
|
|
46
|
-
| Location | Purpose |
|
|
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
|
-
```
|
|
67
|
-
|
|
68
|
-
`--home` redirects managed installation files; it does not make your running host discover that home or inherit permissions. The installed launcher defaults subsequent operations to its own installation home. Remove the disposable directory after inspection if desired; do not replace it with a real home.
|
|
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)
|
|
69
11
|
|
|
70
12
|
<a id="hosts"></a>
|
|
71
|
-
|
|
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
|
|
72
16
|
|
|
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. |
|
|
17
|
+
After installation, open a new tool session and select Aimship:
|
|
78
18
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
Codex
|
|
82
|
-
|
|
83
|
-
|
|
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 |
|
|
84
24
|
|
|
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
|
-
```
|
|
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.
|
|
90
26
|
|
|
91
|
-
|
|
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.
|
|
92
28
|
|
|
93
29
|
<a id="start"></a>
|
|
94
30
|
<a id="describe-the-work-and-its-endpoint"></a>
|
|
95
|
-
##
|
|
31
|
+
## 2. Start from your current situation
|
|
96
32
|
|
|
97
|
-
|
|
33
|
+
### Starting with an idea
|
|
98
34
|
|
|
99
|
-
|
|
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.
|
|
100
36
|
|
|
101
|
-
|
|
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.
|
|
102
38
|
|
|
103
|
-
|
|
39
|
+
### Working from an existing PRD, prototype or other materials
|
|
104
40
|
|
|
105
|
-
|
|
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.
|
|
106
42
|
|
|
107
|
-
|
|
108
|
-
<a id="keep-only-useful-artifacts"></a>
|
|
109
|
-
## 4. Documents, stages and generation rules
|
|
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.
|
|
110
44
|
|
|
111
|
-
|
|
45
|
+
### Changing a feature, fixing a defect or refactoring
|
|
112
46
|
|
|
113
|
-
|
|
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.
|
|
114
48
|
|
|
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 |
|
|
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.
|
|
121
50
|
|
|
122
|
-
|
|
51
|
+
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.
|
|
123
52
|
|
|
124
|
-
|
|
53
|
+
<a id="review"></a>
|
|
54
|
+
<a id="review-documents-and-continue"></a>
|
|
55
|
+
## 3. Proceed and review
|
|
125
56
|
|
|
126
|
-
|
|
57
|
+
The usual development order is PRD/Scope → technical design → interfaces and independent SQL when applicable → test cases → implementation plan → implementation/review/verification → handoff and acceptance. Prototype, investigation and design-only work keep their agreed endpoint; review-only and verify-only reuse their existing basis.
|
|
127
58
|
|
|
128
|
-
|
|
59
|
+
For each document requiring your review, the agent generates and self-checks it, provides a link, a short summary and the next stage, then waits for your review. Read the document and either request changes or explicitly approve it. Requested edits are revised, self-checked and presented again. Questions, silence and asking to see results do not count as approval.
|
|
129
60
|
|
|
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 |
|
|
145
|
-
|
|
146
|
-
During development, `plan` completes before the first implementation. Each implementation batch is reviewed, followed by overall review and independent verification. Test code can be authored during implementation; there is no full testing gate imposed after each batch. For one batch, one review may cover both batch and overall scope if explicitly recorded. Verification-only work may adopt existing versioned cases without claiming to have executed `test-design`.
|
|
147
|
-
|
|
148
|
-
Ordinary debugging and known-cause bugs do not add `diagnose`. Fix implementation defects in implementation, design errors in technical design, requirement gaps in PRD/Scope, and incorrect expectations in versioned cases. A major unknown requiring separate investigation needs a recorded stage adjustment; dependent work waits.
|
|
149
|
-
|
|
150
|
-
### SQL, changes and progress
|
|
151
|
-
|
|
152
|
-
| Artifact | Generation rule and content |
|
|
153
|
-
| --- | --- |
|
|
154
|
-
| `database.sql` | Required when database structures or data change; one database target uses this single root-level file |
|
|
155
|
-
| `database-<id>.sql` | Multiple independent database targets get one file each; use a stable target ID |
|
|
156
|
-
| `change-log.md` | Record meaningful changes: reason, old/new meaning, decision, affected documents/work and remaining actions |
|
|
157
|
-
| `status.md` | Generated reading entry: goal, progress, blockers, next action and document links |
|
|
158
|
-
| `.aimship/state.json` | Managed state: goal/stages, document references, version binding and associated repositories/worktrees/code locations |
|
|
61
|
+
Your explicit approval is recorded against that document version and automatically starts the next authorized stage; no second start confirmation is needed. If you have explicitly arranged to continue in a new session, the agent saves a handoff first; see [session arrangements](#continue). The chat shows the current stage, pending document, review status and next stage. Document approval is separate from final delivery acceptance.
|
|
159
62
|
|
|
160
|
-
|
|
63
|
+
Authorized implementation, agent reviews, defect repairs and retests can proceed continuously. Each implementation batch is reviewed, followed by overall review and independent verification. New material decisions and production actions still need authorization.
|
|
161
64
|
|
|
162
|
-
|
|
65
|
+
<a id="results"></a>
|
|
66
|
+
<a id="3-inspect-progress-and-results"></a>
|
|
67
|
+
## 4. Inspect progress and results
|
|
163
68
|
|
|
164
|
-
|
|
69
|
+
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.
|
|
165
70
|
|
|
166
|
-
|
|
71
|
+
<a id="delivery-structure"></a>
|
|
72
|
+
### Delivery structure and documents
|
|
167
73
|
|
|
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 |
|
|
74
|
+
By default, each request has its own delivery directory under `~/Aimship/`, while code stays in its existing repositories.
|
|
175
75
|
|
|
176
|
-
|
|
76
|
+
The tree below lists delivery artifacts and their purposes. Files are generated according to the selected stages and input conditions; unselected stages produce no empty documents. `prd.md` and `scope.md` are alternative requirement entries, not two files required for every delivery.
|
|
177
77
|
|
|
178
|
-
|
|
78
|
+
```text
|
|
79
|
+
~/Aimship/
|
|
80
|
+
├── 20261023-order-export/ # One request, one delivery folder
|
|
81
|
+
│ ├── status.md # Generated overview and reading entry
|
|
82
|
+
│ ├── prd.md # Authored requirements, scope and acceptance
|
|
83
|
+
│ ├── scope.md # Used instead of PRD when adopting authoritative inputs
|
|
84
|
+
│ ├── tech-design.md # Architecture, changes, data, risks and requirement coverage
|
|
85
|
+
│ ├── plan.md # Implementation batches, tasks and actual execution
|
|
86
|
+
│ ├── testing.md # Test cases, coverage, runs and retest results
|
|
87
|
+
│ ├── review.md # Batch/overall reviews, findings and follow-up
|
|
88
|
+
│ ├── handoff.md # Delivered result, usage, validation and remaining work
|
|
89
|
+
│ ├── diagnosis.md # Only for an independent investigation
|
|
90
|
+
│ ├── change-log.md # Meaningful changes, decisions and affected work
|
|
91
|
+
│ ├── openapi.yaml # New HTTP contract; reuse an existing authority when available
|
|
92
|
+
│ ├── database.sql # SQL for one database; multiple targets use database-<id>.sql
|
|
93
|
+
│ ├── prototype/ # Newly authored prototypes when required
|
|
94
|
+
│ │ └── index.html # Entry for an HTML prototype; its assets stay here
|
|
95
|
+
│ ├── source/ # Preserved original request and adopted input versions
|
|
96
|
+
│ │ ├── request.md # Original commission or source entry
|
|
97
|
+
│ │ └── … # External PRD, prototype, screenshots and other inputs
|
|
98
|
+
│ └── .aimship/ # Managed state and supporting evidence
|
|
99
|
+
│ ├── state.json # Stages, references, versions and repository/worktree links
|
|
100
|
+
│ ├── state.previous.json # Previous state for recovery after writes
|
|
101
|
+
│ ├── view.json # Metadata for the generated status view
|
|
102
|
+
│ └── evidence/ # Evidence retained when needed
|
|
103
|
+
└── 20261024-another-request/ # Independent request and progress
|
|
104
|
+
```
|
|
179
105
|
|
|
180
|
-
|
|
106
|
+
Formal documents are directly in the request folder. `source/` preserves adopted originals; `.aimship/` holds internal records. The software itself is installed separately in `~/.aimship/`.
|
|
181
107
|
|
|
182
|
-
|
|
108
|
+
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 reference](reference.md) explains exactly when each artifact is produced and what it contains.
|
|
183
109
|
|
|
184
110
|
<a id="changes"></a>
|
|
185
111
|
<a id="review-verify-and-change"></a>
|
|
186
|
-
|
|
112
|
+
<a id="4-requirements-change-during-delivery"></a>
|
|
113
|
+
## 5. Requirements change during delivery
|
|
187
114
|
|
|
188
|
-
|
|
115
|
+
Explain what changed, why, and what should remain. If you edited a formal document, identify the location so the agent can reconcile its meaning.
|
|
189
116
|
|
|
190
|
-
|
|
117
|
+
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.
|
|
191
118
|
|
|
192
|
-
|
|
119
|
+
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.
|
|
120
|
+
|
|
121
|
+
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.
|
|
193
122
|
|
|
194
123
|
<a id="continue"></a>
|
|
195
124
|
<a id="continue-in-another-conversation"></a>
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
125
|
+
<a id="5-resume-after-a-pause-or-in-another-session"></a>
|
|
126
|
+
<a id="6-resume-after-a-pause-or-in-another-session"></a>
|
|
127
|
+
## 6. Session arrangements and continuing work
|
|
199
128
|
|
|
200
|
-
|
|
129
|
+
### The maintainer's session practice
|
|
201
130
|
|
|
202
|
-
|
|
131
|
+
To manage growing context, the maintainer has used the following arrangement of separate sessions (windows):
|
|
203
132
|
|
|
204
|
-
|
|
133
|
+
| Work | Session arrangement |
|
|
134
|
+
| --- | --- |
|
|
135
|
+
| Requirements / Scope | One session |
|
|
136
|
+
| Technical design, SQL and interface documents | One shared session |
|
|
137
|
+
| Test-case design | One session |
|
|
138
|
+
| Implementation plan | One session |
|
|
139
|
+
| Implementation | One session per implementation batch, including that batch's agent review |
|
|
140
|
+
| Overall review | One session |
|
|
141
|
+
| Test execution | One session per test batch |
|
|
205
142
|
|
|
206
|
-
|
|
207
|
-
<a id="work-on-two-requests-at-once"></a>
|
|
208
|
-
## 7. Parallel deliveries
|
|
143
|
+
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 window does not bypass approval.
|
|
209
144
|
|
|
210
|
-
|
|
145
|
+
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 window 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.
|
|
211
146
|
|
|
212
|
-
|
|
147
|
+
### Arrange the next session and hand off
|
|
213
148
|
|
|
214
|
-
|
|
149
|
+
Aimship defines stages, artifacts, reviews and handoffs; it does not create new sessions. When changing windows, open a new session in your AI tool and provide the same delivery directory and handoff information.
|
|
215
150
|
|
|
216
|
-
|
|
217
|
-
<a id="update-or-stop-using-aimship"></a>
|
|
218
|
-
## 8. Software updates and delivery compatibility
|
|
151
|
+
If you want to change sessions after approving a document, say so with the approval, for example: “This document is approved. Save the handoff first; I will continue in a new window.” The agent records approval and your continuation arrangement without starting the next stage in the current session. For implementation or test batches, you can instead say: “Finish this batch, save the results and handoff, and leave the next batch for a new session.” This does not add human approval requirements to execution records.
|
|
219
152
|
|
|
220
|
-
|
|
153
|
+
Before ending the current session, have the agent save progress, review status, unresolved issues and the next step, and provide the full delivery directory path and relevant code locations. In the new session, select Aimship and provide the same delivery directory. The agent reads the relevant complete formal documents and state, checks actual artifacts and continues according to the saved arrangement. Ensure that a different tool can access the same materials and code.
|
|
221
154
|
|
|
222
|
-
|
|
223
|
-
npx aimship@preview install
|
|
224
|
-
```
|
|
155
|
+
Keep only one writing session per delivery; the old session must stop writing before the new one takes over. Pending documents still require your explicit approval, and changing windows cannot bypass review. Progress and next steps remain in the same `status.md`; you do not need to copy the entire chat.
|
|
225
156
|
|
|
226
|
-
|
|
157
|
+
### Handle interruptions and version changes
|
|
227
158
|
|
|
228
|
-
|
|
159
|
+
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.
|
|
229
160
|
|
|
230
|
-
|
|
161
|
+
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.
|
|
231
162
|
|
|
232
|
-
|
|
163
|
+
<a id="parallel"></a>
|
|
164
|
+
<a id="work-on-two-requests-at-once"></a>
|
|
165
|
+
<a id="6-progress-several-deliveries-at-once"></a>
|
|
166
|
+
## 7. Progress several deliveries at once
|
|
233
167
|
|
|
234
|
-
|
|
235
|
-
## 9. Host disconnection and uninstallation
|
|
168
|
+
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.
|
|
236
169
|
|
|
237
|
-
|
|
170
|
+
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.
|
|
238
171
|
|
|
239
|
-
|
|
240
|
-
node "$HOME/.aimship/bin/aimship.mjs" uninstall --host cursor
|
|
241
|
-
```
|
|
172
|
+
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.
|
|
242
173
|
|
|
243
|
-
|
|
174
|
+
<a id="completion"></a>
|
|
175
|
+
<a id="decide-when-work-is-done"></a>
|
|
176
|
+
<a id="7-complete-a-delivery"></a>
|
|
177
|
+
## 8. Complete a delivery
|
|
244
178
|
|
|
245
|
-
|
|
179
|
+
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.
|
|
246
180
|
|
|
247
|
-
|
|
248
|
-
node "$HOME/.aimship/bin/aimship.mjs" uninstall
|
|
249
|
-
```
|
|
181
|
+
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.
|
|
250
182
|
|
|
251
|
-
|
|
183
|
+
Small later corrections can continue the same delivery while preserving its earlier completion record. A new goal or substantial redesign starts a related delivery.
|
|
252
184
|
|
|
253
185
|
<a id="troubleshoot"></a>
|
|
254
|
-
|
|
186
|
+
<a id="8-problems-during-use"></a>
|
|
187
|
+
## 9. Problems during use
|
|
255
188
|
|
|
256
|
-
|
|
|
189
|
+
| Situation | What to do |
|
|
257
190
|
| --- | --- |
|
|
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).
|
|
191
|
+
| 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 |
|
|
192
|
+
| The progress page differs from actual results | Have the agent inspect current records and files, preserve manual edits and regenerate the progress page |
|
|
193
|
+
| A formal document changed outside the session | Identify the changes and have the agent assess their meaning and effect on subsequent work |
|
|
194
|
+
| An old delivery cannot continue | Have the agent check format migration, rule adoption and document reconciliation, preserving historical results and explaining blockers |
|
|
195
|
+
| Aimship is missing, or installation/version problems occur | See [installation and upgrade problems](../README.md#installation-troubleshooting) in the README |
|
|
270
196
|
|
|
271
|
-
|
|
272
|
-
<a id="decide-when-work-is-done"></a>
|
|
273
|
-
## 11. Delivery completion criteria
|
|
197
|
+
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).
|
|
274
198
|
|
|
275
|
-
|
|
199
|
+
## Related references
|
|
276
200
|
|
|
277
|
-
|
|
201
|
+
<a id="artifacts"></a>
|
|
202
|
+
<a id="keep-only-useful-artifacts"></a>
|
|
203
|
+
See the [delivery document reference](reference.md) 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.
|
|
204
|
+
|
|
205
|
+
<a id="update"></a>
|
|
206
|
+
<a id="update-or-stop-using-aimship"></a>
|
|
207
|
+
For software upgrades, adding tools, version queries and installation health checks, see the [README](../README.md#update).
|
|
208
|
+
|
|
209
|
+
<a id="uninstall"></a>
|
|
210
|
+
For tool disconnection or full uninstallation, see the [README](../README.md#uninstall). Source development and isolated validation belong in [Contributing](../CONTRIBUTING.md).
|