aimship 0.1.0-preview.13 → 0.1.0-preview.14
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/README.md +12 -10
- package/README.zh-CN.md +12 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -36,14 +36,14 @@ Choose `codex`, `cursor` or `claude-code`. To connect several tools, repeat the
|
|
|
36
36
|
npx aimship@preview install --host codex --host claude-code
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
The npx package prompt confirms downloading and running the package; `install` performs the Aimship installation or upgrade. `@preview` selects the published preview channel; an exact published version, such as `@0.1.0-preview.14`, can be used instead. The preview channel is experimental and does not imply a stable release.
|
|
40
40
|
|
|
41
41
|
### A specific version or local package
|
|
42
42
|
|
|
43
43
|
To install an exact published version, for example:
|
|
44
44
|
|
|
45
45
|
```sh
|
|
46
|
-
npx aimship@0.1.0-preview.
|
|
46
|
+
npx aimship@0.1.0-preview.14 install --host codex
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
If you already have an Aimship `.tgz` package, replace `VERSION` with its actual version and run from the directory containing it:
|
|
@@ -80,7 +80,9 @@ For the published preview channel:
|
|
|
80
80
|
npx aimship@preview install
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
After upgrading, we recommend restarting your AI tool and opening a new session, then activating Aimship to reload the updated rules. Existing sessions may still retain older rules.
|
|
84
|
+
|
|
85
|
+
Installation and upgrades use the same `install` command. Existing tool registrations, configuration, custom content and deliveries are retained. The installer reports previous/target versions, results and conflicts; no background updater or resident process runs. To upgrade to a specific version, for example, run `npx aimship@0.1.0-preview.14 install`. Existing installations do not need `--host` or `--data-root` repeated.
|
|
84
86
|
|
|
85
87
|
<a id="add-a-host"></a>
|
|
86
88
|
<a id="add-an-ai-development-tool"></a>
|
|
@@ -97,22 +99,22 @@ This retains existing tools and installs the selected preview version; it also u
|
|
|
97
99
|
### Check the installed version
|
|
98
100
|
|
|
99
101
|
```sh
|
|
100
|
-
|
|
102
|
+
node "$HOME/.aimship/bin/aimship.mjs" --version
|
|
101
103
|
```
|
|
102
104
|
|
|
103
|
-
|
|
105
|
+
This command queries the installed local launcher directly. `installedActiveVersion` is the active installed version. The query neither downloads a package nor upgrades the installation.
|
|
104
106
|
|
|
105
107
|
### Check installation health
|
|
106
108
|
|
|
107
109
|
```sh
|
|
108
|
-
|
|
110
|
+
node "$HOME/.aimship/bin/aimship.mjs" status
|
|
109
111
|
```
|
|
110
112
|
|
|
111
113
|
This checks the software installation, tool registrations and managed files, reporting health and pending problems. It cannot confirm that a tool loaded the Skill. For delivery progress, open that delivery's `status.md`.
|
|
112
114
|
|
|
113
|
-
These
|
|
115
|
+
These queries use the default installation location. If you installed with a different `--home`, use `.aimship/bin/aimship.mjs` under that location.
|
|
114
116
|
|
|
115
|
-
|
|
117
|
+
Save current work before upgrading. Afterwards, check the version and health with the commands above, and follow [session continuation](docs/guide.md#continue) to check delivery state when resuming work.
|
|
116
118
|
|
|
117
119
|
<a id="uninstall"></a>
|
|
118
120
|
## Uninstallation
|
|
@@ -140,8 +142,8 @@ Full uninstall retains delivery materials, user code, custom files and necessary
|
|
|
140
142
|
| --- | --- |
|
|
141
143
|
| Aimship is absent or duplicated | Refresh the session and inspect entries using [tool setup](docs/guide.md#hosts); installation health does not prove the tool loaded the Skill. |
|
|
142
144
|
| A managed path is modified or occupied by other files | Preserve the contents, inspect ownership and explicitly reconcile customizations before retrying. |
|
|
143
|
-
| Installation was interrupted or the launcher is damaged | Use the `status` command above, resolve the cause, then rerun the exact pending version against the same home. Do not switch versions during recovery.
|
|
144
|
-
| Unexpected version |
|
|
145
|
+
| Installation was interrupted or the launcher is damaged | Use the `status` command above, resolve the cause, then rerun the exact pending version against the same home. Do not switch versions during recovery. For a custom installation, use the local launcher under its original installation home. |
|
|
146
|
+
| Unexpected version | Query `installedActiveVersion` through the local launcher. To upgrade, run `install`, then check the version and refresh the session's rules. |
|
|
145
147
|
| Package/version unavailable or download failed | Check the package, exact version and registry; a failed download is not a completed installation. |
|
|
146
148
|
|
|
147
149
|
## Documentation and contributions
|
package/README.zh-CN.md
CHANGED
|
@@ -36,14 +36,14 @@ AI 工具可选 `codex`、`cursor` 或 `claude-code`。连接多个 AI 工具时
|
|
|
36
36
|
npx aimship@preview install --host codex --host claude-code
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
npx 的获取包提示只确认下载并运行该包；执行 `install` 才会安装或升级 Aimship。`@preview` 表示已发布的预览通道，也可以替换为明确版本号，例如 `@0.1.0-preview.14`。预览通道用于实验性版本，不代表稳定版。
|
|
40
40
|
|
|
41
41
|
### 指定版本或本地包
|
|
42
42
|
|
|
43
43
|
安装指定的已发布版本，例如：
|
|
44
44
|
|
|
45
45
|
```sh
|
|
46
|
-
npx aimship@0.1.0-preview.
|
|
46
|
+
npx aimship@0.1.0-preview.14 install --host codex
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
如果已有 Aimship 的 `.tgz` 安装包，将 `VERSION` 替换为实际版本号，在包所在目录执行：
|
|
@@ -80,7 +80,9 @@ npx aimship@preview install --host codex --data-root "./MyDeliveries"
|
|
|
80
80
|
npx aimship@preview install
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
升级完成后，建议重启 AI 工具并新建会话，再启用 Aimship，以便重新加载更新后的规则。已有会话可能仍保留旧规则。
|
|
84
|
+
|
|
85
|
+
安装和升级使用同一个 `install` 命令。已有 AI 工具登记、配置、自定义内容和交付资料都会保留。安装器报告旧／目标版本、结果及冲突；没有后台自动升级或常驻进程。更新到指定版本时，例如运行 `npx aimship@0.1.0-preview.14 install`。已有安装无需重复填写 `--host` 或 `--data-root`。
|
|
84
86
|
|
|
85
87
|
<a id="添加宿主"></a>
|
|
86
88
|
<a id="添加-ai-开发工具"></a>
|
|
@@ -97,22 +99,22 @@ npx aimship@preview install --host cursor
|
|
|
97
99
|
### 查询已安装版本
|
|
98
100
|
|
|
99
101
|
```sh
|
|
100
|
-
|
|
102
|
+
node "$HOME/.aimship/bin/aimship.mjs" --version
|
|
101
103
|
```
|
|
102
104
|
|
|
103
|
-
|
|
105
|
+
该命令直接查询已安装的本机入口，`installedActiveVersion` 是实际生效版本。查询不会下载包或升级安装。
|
|
104
106
|
|
|
105
107
|
### 检查安装状态
|
|
106
108
|
|
|
107
109
|
```sh
|
|
108
|
-
|
|
110
|
+
node "$HOME/.aimship/bin/aimship.mjs" status
|
|
109
111
|
```
|
|
110
112
|
|
|
111
113
|
此命令检查软件安装、AI 工具登记和受管理文件，报告是否健康及待处理问题；它不能确认 AI 工具已加载 Skill。查看需求进度请打开交付目录的 `status.md`。
|
|
112
114
|
|
|
113
|
-
|
|
115
|
+
以上查询使用默认安装位置；若安装时指定了其他 `--home`，使用该位置下的 `.aimship/bin/aimship.mjs`。
|
|
114
116
|
|
|
115
|
-
|
|
117
|
+
升级前保存当前工作。升级后用上述命令核对版本和健康状态，继续交付时按[会话接续](docs/guide.zh-CN.md#continue)核对交付状态。
|
|
116
118
|
|
|
117
119
|
<a id="uninstall"></a>
|
|
118
120
|
## 卸载
|
|
@@ -140,8 +142,8 @@ npx aimship@preview uninstall
|
|
|
140
142
|
| --- | --- |
|
|
141
143
|
| 找不到 Aimship 或出现重复项 | 按[AI 工具设置](docs/guide.zh-CN.md#hosts)刷新会话并检查入口；安装健康不代表 AI 工具已经加载 Skill。 |
|
|
142
144
|
| 管理位置被修改或被其他文件占用 | 保留内容，检查归属，明确合并定制内容后再重试。 |
|
|
143
|
-
| 安装中断或稳定入口损坏 | 使用上面的 `status`
|
|
144
|
-
| 版本与预期不一致 |
|
|
145
|
+
| 安装中断或稳定入口损坏 | 使用上面的 `status` 命令检查安装，排除原因后在同一目录重跑完全相同的待恢复版本；不要在恢复途中换版本。自定义安装应使用原安装用户目录下的本机入口。 |
|
|
146
|
+
| 版本与预期不一致 | 用本机入口查询 `installedActiveVersion`；需要升级时执行 `install`，再核对版本并刷新会话中的规则。 |
|
|
145
147
|
| 包／版本不存在或下载失败 | 核对包名、明确版本和 registry；下载失败不算安装完成。 |
|
|
146
148
|
|
|
147
149
|
## 文档与贡献
|