robisie 0.1.1 → 0.1.3
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/CHANGELOG.md +18 -0
- package/README.md +101 -13
- package/dist/cli.js +17 -13
- package/dist/commands.js +8 -6
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +1 -1
- package/dist/helpers.js +17 -11
- package/dist/mcp.js +48 -21
- package/dist/opencode-result.js +1 -1
- package/dist/role-registry.d.ts +7 -1
- package/dist/role-registry.js +11 -3
- package/dist/roles.d.ts +1 -1
- package/docs/ENGINE-API.md +12 -2
- package/docs/ENGINE-CONFIG.md +9 -11
- package/docs/README.en.md +211 -17
- package/docs/README.md +211 -17
- package/package.json +1 -1
package/docs/README.en.md
CHANGED
|
@@ -1,19 +1,23 @@
|
|
|
1
|
-
# robisie — from account to accepted card (package 0.1.
|
|
1
|
+
# robisie — from account to accepted card (package 0.1.3)
|
|
2
2
|
|
|
3
3
|
Polski: [README.md](README.md).
|
|
4
4
|
|
|
5
5
|
<!-- sekcja: dostepnosc -->
|
|
6
6
|
## Availability
|
|
7
7
|
|
|
8
|
+
An account and key are needed for init and the roles. Offline configuration validation is a separate entry point when the CLI is available: it does not check the installation, start providers or require a project UUID from you. Separately, `npx robisie doctor --engine-config ./robisie.config.json` checks only configuration structure offline: it does not confirm project UUID, repo, models or provider execution. The guides shipped in this package are local at `node_modules/robisie/docs/README.md` and `node_modules/robisie/docs/README.en.md`; no website fetch is needed.
|
|
9
|
+
|
|
8
10
|
Install robisie from npm in the prepared directory; run subsequent commands and agent sessions there. [Preparation](#wymagania) → [account](#konto) → [key](#klucz) → [installation](#instalacja) → [acceptance](#recenzja-i-odbior).
|
|
9
11
|
|
|
12
|
+
The CHANGELOG entry about registry README readback describes a release check, not proof that a particular publication has a nonempty README. E4 observed an empty registry README while the tarball contained the guides; use `node_modules/robisie/docs/` locally. Registry metadata, publication and historical CHANGELOG correction require separate release work.
|
|
13
|
+
|
|
10
14
|
<!-- sekcja: wymagania -->
|
|
11
15
|
<a id="wymagania"></a>
|
|
12
16
|
## Requirements
|
|
13
17
|
|
|
14
|
-
The human prepares Node.js 20+, npm, internet for dependencies and robisie, and one provider program: Claude Code, Codex CLI or OpenCode with their own AI access. Check `node --version`, `npm --version` and the chosen program's version (`claude --version`, `codex --version` or `opencode --version`). If absent from PATH, install it following its provider's instructions and check again; a configuration directory alone is insufficient.
|
|
18
|
+
The human prepares Node.js 20+, npm, internet for dependencies and robisie, and one provider program: Claude Code, Codex CLI or OpenCode with their own AI access. Check `node --version`, `npm --version` and the chosen program's version (`claude --version`, `codex --version` or `opencode --version`). If absent from PATH, install it following its provider's instructions and check again; a configuration directory alone is insufficient. Windows/WSL are unverified; examples below use POSIX paths.
|
|
15
19
|
|
|
16
|
-
Prepare an empty directory on disk.
|
|
20
|
+
Prepare an empty directory on disk. You do not need a website or your own `package.json`; the Node.js step below creates it before installation. This is the agents' working directory, separate from the dashboard project.
|
|
17
21
|
|
|
18
22
|
<!-- sekcja: konto -->
|
|
19
23
|
<a id="konto"></a>
|
|
@@ -21,15 +25,17 @@ Prepare an empty directory on disk. No website or `package.json` is needed; npm
|
|
|
21
25
|
|
|
22
26
|
The human signs in at https://robisie.app with Google or an email link. Wait for the first project's readiness screen. If readiness is missing, use the fallback link to https://robisie.app/dashboard/plugins/planer and prepare a project in the dashboard; the bounded readiness checks are not a provisioning time guarantee.
|
|
23
27
|
|
|
24
|
-
The CEO requires authenticated discovery to return exactly one project. A dashboard project is not a directory on disk: confirm with the CEO that both concern the same goal before work. With zero projects, the human checks readiness and the dashboard fallback; with several, the human must organize/archive extras until discovery returns one. Clicking a project does not bind it for the CEO. Do not supply a project UUID in chat; the CEO takes its identifier only from discovery. Result: one recognized project before any agent write.
|
|
28
|
+
Discovery is the authenticated read of active projects through `list_projects`; the key scopes what the agent sees. The CEO requires authenticated discovery to return exactly one project. A dashboard project is not a directory on disk: confirm with the CEO that both concern the same goal before work. With zero projects, the human checks readiness and the dashboard fallback; with several, the human must organize/archive extras until discovery returns one. Clicking a project does not bind it for the CEO. Do not supply a project UUID in chat; the CEO takes its identifier only from discovery. Result: one recognized project before any agent write.
|
|
25
29
|
|
|
26
30
|
<!-- sekcja: klucz -->
|
|
27
31
|
<a id="klucz"></a>
|
|
28
32
|
## Key in Connect
|
|
29
33
|
|
|
34
|
+
An agent may create its own account and generate its key, within the account owner’s authorization. A human may need to confirm sign-in or another protected step; then continue after that confirmation. Someone else’s open session does not authorize using their account or key. Keep secrets out of chat and command history; if the available tools cannot supply a secret safely, the human enters it in the hidden init prompt.
|
|
35
|
+
|
|
30
36
|
At https://robisie.app/dashboard/connect the human selects `worker` and a recognizable label, such as “tester laptop”, then generates the key. It is shown only once: store it like a password. The human supplies it outside chat to init's hidden prompt, never to chat, a card, a command argument or shell history.
|
|
31
37
|
|
|
32
|
-
`worker` is the minimal path: read, create/update projects, tracks and cards, reserve work; no setting `done` through create/update. `observer` only reads. `full` adds deletion and closing decision matters; `owner_validator` has the same access level as full. `seeder` has narrow access to `get_task` and valid seeding through `append_detail`, without `list_projects`/board reads, so it cannot follow this guide.
|
|
38
|
+
`worker` is the minimal path: read, create/update projects, tracks and cards, reserve work; no setting `done` through create/update. `observer` only reads. Explicitly choose `worker` each time: later keys default to `observer` (the first-key screen may preselect worker); do not infer permissions from that default. `full` adds deletion and closing decision matters; `owner_validator` has the same access level as full. `seeder` has narrow access to `get_task` and valid seeding through `append_detail`, without `list_projects`/board reads, so it cannot follow this guide.
|
|
33
39
|
|
|
34
40
|
The package stores **one key for CEO, Builder and Quality Officer** as `ROBISIE_KEY`. Role names do not change permissions. Do not use full to bypass acceptance of `done`: the owner accepts in the dashboard without broadening the agent's key.
|
|
35
41
|
|
|
@@ -37,17 +43,76 @@ The package stores **one key for CEO, Builder and Quality Officer** as `ROBISIE_
|
|
|
37
43
|
<a id="instalacja"></a>
|
|
38
44
|
## Install from npm
|
|
39
45
|
|
|
40
|
-
After preparing the account and key, the human opens a terminal
|
|
46
|
+
After preparing the account and key, the human opens a terminal and enters the chosen empty directory (replace the example path below). The Node.js step below creates a local `package.json` regardless of the directory name, including spaces and Polish characters. The manifest sets the installation directory even under an ancestor containing `node_modules`. If the `package.json` path already exists (including a symlink), the step refuses to write; it never overwrites it. EEXIST means the path exists: use the existing-project route below; resolve a link/directory first. Failure to enter the directory or create the manifest stops the rest of the block. Then: install, init with the hidden key prompt, doctor. In zsh/bash clear stale ENV before init and load the saved key before doctor — init cannot set its parent environment:
|
|
41
47
|
|
|
42
48
|
```sh
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
49
|
+
cd "/path/to/empty directory" &&
|
|
50
|
+
node -e 'try {
|
|
51
|
+
require("node:fs").writeFileSync("package.json", "{\"private\":true}\n", { flag: "wx" });
|
|
52
|
+
} catch (error) {
|
|
53
|
+
console.error(error.message);
|
|
54
|
+
process.exit(1);
|
|
55
|
+
}' &&
|
|
56
|
+
{
|
|
57
|
+
set +x
|
|
58
|
+
npm i robisie &&
|
|
59
|
+
unset ROBISIE_KEY &&
|
|
60
|
+
npx robisie init --agent claude &&
|
|
61
|
+
{
|
|
62
|
+
if [ ! -L "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" ] &&
|
|
63
|
+
[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" ] &&
|
|
64
|
+
[ -r "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" ] &&
|
|
65
|
+
ROBISIE_KEY="$(cat "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" 2>/dev/null)" &&
|
|
66
|
+
[ -n "$ROBISIE_KEY" ]; then
|
|
67
|
+
export ROBISIE_KEY
|
|
68
|
+
else
|
|
69
|
+
printf '%s\n' 'Cannot load a nonempty regular readable robisie key file.' 'Next step: check the key file and its permissions locally; resolve links/directories without overwriting data. If the key is missing or revoked, use Connect and init with the hidden prompt. Never paste the key into chat.' >&2
|
|
70
|
+
false
|
|
71
|
+
fi
|
|
72
|
+
} &&
|
|
47
73
|
npx robisie doctor
|
|
74
|
+
}
|
|
48
75
|
```
|
|
49
76
|
|
|
50
|
-
|
|
77
|
+
The `&&` chain stops the block at the first error; assigning the key separately before `export` preserves the read status so doctor cannot mask it. After resolving the cause, retry the failed step and every subsequent step from the block in the same directory. If the manifest was already created, do not repeat its creation or delete it.
|
|
78
|
+
|
|
79
|
+
For an existing project without `package.json`, run the fresh-install block above in that project directory: it creates only a private manifest and preserves other project files. If a regular manifest already exists, or you are reinstalling with a retained valid key, use the block below in the chosen project directory. It loads the saved key before npm/init/doctor, does not overwrite a regular manifest during preparation, and creates one with `wx` only if absent. npm itself may then add the robisie dependency and change the lockfile. It refuses a manifest link (including a dangling link) or directory with an explanation. After uninstall, when no valid key remains, return to Connect and the hidden init prompt: for an existing regular manifest run the fresh-install block from `set +x` through doctor, without its `cd`/manifest creation step. Do not delete a manifest to repeat installation.
|
|
80
|
+
|
|
81
|
+
<!-- reinstall:start -->
|
|
82
|
+
```sh
|
|
83
|
+
set +x
|
|
84
|
+
{
|
|
85
|
+
if [ ! -L "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" ] &&
|
|
86
|
+
[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" ] &&
|
|
87
|
+
[ -r "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" ] &&
|
|
88
|
+
ROBISIE_KEY="$(cat "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" 2>/dev/null)" &&
|
|
89
|
+
[ -n "$ROBISIE_KEY" ]; then
|
|
90
|
+
export ROBISIE_KEY
|
|
91
|
+
else
|
|
92
|
+
printf '%s\n' 'Cannot load a nonempty regular readable robisie key file.' 'Next step: check the key file and its permissions locally; resolve links/directories without overwriting data. If the key is missing or revoked, use Connect and init with the hidden prompt. Never paste the key into chat.' >&2
|
|
93
|
+
false
|
|
94
|
+
fi
|
|
95
|
+
} &&
|
|
96
|
+
node -e 'try {
|
|
97
|
+
const fs = require("node:fs");
|
|
98
|
+
let existing;
|
|
99
|
+
try { existing = fs.lstatSync("package.json"); }
|
|
100
|
+
catch (error) { if (error.code !== "ENOENT") throw error; }
|
|
101
|
+
if (existing) {
|
|
102
|
+
if (!existing.isFile()) throw new Error("package.json: expected a regular file; links and directories refused");
|
|
103
|
+
} else fs.writeFileSync("package.json", "{\"private\":true}\n", { flag: "wx" });
|
|
104
|
+
} catch (error) {
|
|
105
|
+
console.error(error.message);
|
|
106
|
+
console.error("Next step: check package.json locally; preserve the file and resolve its path before retrying.");
|
|
107
|
+
process.exit(1);
|
|
108
|
+
}' &&
|
|
109
|
+
npm i robisie &&
|
|
110
|
+
npx robisie init &&
|
|
111
|
+
npx robisie doctor
|
|
112
|
+
```
|
|
113
|
+
<!-- reinstall:end -->
|
|
114
|
+
|
|
115
|
+
For Codex or OpenCode replace `claude` with `codex` or `opencode`. With existing configuration, use the complete map in the next section; `--agent` alone does not clear it. Expected doctor result: exit 0. Prepare a compatible fallback tgz using Update below. Init configures `client-launch-context` and `ceo-client-launcher` for the package version; a local invocation is `npx robisie mcp <name>` from the installation cwd. Agent entries retain the transport generated by the package; this guide does not change it. npx may download the package when the required version is not available locally.
|
|
51
116
|
|
|
52
117
|
<!-- sekcja: init -->
|
|
53
118
|
## Connect your agent
|
|
@@ -73,7 +138,19 @@ npx robisie init --agent opencode --role ceo=opencode --role builder=opencode --
|
|
|
73
138
|
Profile support is limited to zsh/bash without `--no-shell`. With another shell or `--no-shell`, the human sets the agent session's environment securely. A POSIX shell can load the stored file without displaying its contents:
|
|
74
139
|
|
|
75
140
|
```sh
|
|
76
|
-
|
|
141
|
+
set +x
|
|
142
|
+
{
|
|
143
|
+
if [ ! -L "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" ] &&
|
|
144
|
+
[ -f "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" ] &&
|
|
145
|
+
[ -r "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" ] &&
|
|
146
|
+
ROBISIE_KEY="$(cat "${XDG_CONFIG_HOME:-$HOME/.config}/robisie/key" 2>/dev/null)" &&
|
|
147
|
+
[ -n "$ROBISIE_KEY" ]; then
|
|
148
|
+
export ROBISIE_KEY
|
|
149
|
+
else
|
|
150
|
+
printf '%s\n' 'Cannot load a nonempty regular readable robisie key file.' 'Next step: check the key file and its permissions locally; resolve links/directories without overwriting data. If the key is missing or revoked, use Connect and init with the hidden prompt. Never paste the key into chat.' >&2
|
|
151
|
+
false
|
|
152
|
+
fi
|
|
153
|
+
}
|
|
77
154
|
```
|
|
78
155
|
|
|
79
156
|
A new terminal alone does not guarantee the key: retain the installation's XDG_CONFIG_HOME and check doctor in the target session. With only `opencode.jsonc`, init refuses before writing. A remote MCP entry in jsonc does not install roles or helpers. Preserve the configuration; the human prepares a supported `opencode.json` without comments according to OpenCode settings, or selects another installed provider for all roles. The package does not convert JSONC.
|
|
@@ -144,9 +221,120 @@ In other CEO sessions, including Codex, moving to delivered requires independent
|
|
|
144
221
|
The project owner can use Dashboard → Planer → card → Etap → “Zrobione” to move `delivered` to `done`, including when the agent uses a `worker` key. For the first card described here, the server does not enforce stored acceptance or evidence before a change to `done`: the dashboard lets the owner select “Zrobione” even without them. Do this only after checking and explicitly accepting the result. The dashboard cannot edit `details`; review and evidence are recorded through the supported board tool flow. This guide alone does not prove a customer has completed that flow.
|
|
145
222
|
|
|
146
223
|
<!-- sekcja: aktualizacja -->
|
|
147
|
-
## Update
|
|
224
|
+
## Update and private backup
|
|
225
|
+
|
|
226
|
+
Work in the installation directory. First prepare the backup below. Explicitly choose the previous release compatible with the server contract MAJOR; inspect the installed version with `node -p 'require("./node_modules/robisie/package.json").version'`. Replace the example `previous_version='0.1.1'` with that chosen version. `npm pack robisie@<wersja>` means pack the explicitly selected release, not an arbitrary tgz. Retain its filename and the backup directory. Disable xtrace; never print or paste secrets.
|
|
227
|
+
|
|
228
|
+
```sh
|
|
229
|
+
set +x
|
|
230
|
+
umask 077 &&
|
|
231
|
+
config_home="${XDG_CONFIG_HOME:-$HOME/.config}" &&
|
|
232
|
+
codex_home="${CODEX_HOME:-$HOME/.codex}" &&
|
|
233
|
+
backup="$(mktemp -d "$HOME/robisie-backup.XXXXXX")" &&
|
|
234
|
+
mkdir -p "$backup/project" "$backup/robisie/backups" "$backup/robisie/roles/codex" \
|
|
235
|
+
"$backup/claude/agents" "$backup/codex" "$backup/opencode/agents" \
|
|
236
|
+
"$backup/opencode/plugins" "$backup/profile" "$backup/entries" &&
|
|
237
|
+
previous_version='0.1.1' &&
|
|
238
|
+
npm pack "robisie@$previous_version" --pack-destination "$backup"
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
Keep the installation's HOME, XDG_CONFIG_HOME and CODEX_HOME values (the commands use HOME defaults when ENV is absent). Keep them for restore too. Inspect the local `$config_home/robisie/manifest.json`: `manifest.entries` records actual `path` and prior `backup` paths. Do not paste configuration containing a key into chat. A readable legacy manifest without roleProviders still has useful entries; its age alone does not require a new installation. `roleProviders: null` means unassigned — follow doctor without guessing the map.
|
|
242
|
+
|
|
243
|
+
Missing/null/empty/malformed project configuration or installation record cannot guarantee restore. Preserve available data, run local `npx robisie doctor` and follow its advice; new init cannot reconstruct a missing record. Resolve record or key-read errors before network errors. Never replace a damaged record with an empty one.
|
|
244
|
+
|
|
245
|
+
Follow four steps; the table is a reference for selecting files, not twenty mandatory copies:
|
|
246
|
+
|
|
247
|
+
1. Preserve project manifests (`package.json` and `package-lock.json`), project configuration and robisie’s installation record/key. Record absent files in `absent.txt`.
|
|
248
|
+
2. From `manifest.entries`, select only installed providers, the recorded profile, roles and prior backups. Apply all path, type and readability checks below.
|
|
249
|
+
3. Make and check only those copies; retain their paths and the selected release tgz privately.
|
|
250
|
+
4. Update only after the copies are complete. To restore, compare later changes and restore BOTH project manifests before the tgz command, then load the key → install tgz → init → doctor.
|
|
251
|
+
|
|
252
|
+
The table contains separate commands for manual selection, not a block to run wholesale. Copy project and robisie files and only the providers used in the record, never all of `~/.claude/`, CODEX_HOME or the OpenCode directory. Before each command check the type and readability of source, destination and their ancestors. For `backups/` and `roles/codex/`, inspect every child as well. An unreadable file/entry or a symlink (including dangling links and linked ancestors) stops the recipe: preserve state and compare paths, never blindly cp through a link. A directory where a file is expected also needs investigation. If a file is absent, record its full path in `$backup/absent.txt`, e.g. `printf '%s\n' "$PWD/robisie.config.json" >> "$backup/absent.txt"`; skip cp in both directions. Do not delete files created later during restore.
|
|
253
|
+
|
|
254
|
+
Set `profile` to the profile actually changed in manifest.entries: zsh `${ZDOTDIR:-$HOME}/.zshrc`; bash on macOS the first readable `$HOME/.bash_profile`, `$HOME/.bash_login`, `$HOME/.profile` (fallback `.bash_profile`); bash elsewhere `$HOME/.bashrc`. With `--no-shell`/another shell do not invent a profile; still preserve a prior profile entry if recorded. For each additional `path` and `backup` in entries, set `entry_path` to the exact absolute path, choose a unique numeric `entry_id`, and record that pair privately. Repeat the last row for every such file. Do not assume defaults cover prior installations or providers. Create only needed missing destination directories after the same path checks.
|
|
255
|
+
|
|
256
|
+
| Source → private copy (before update) | Copy → restore destination (only after comparison) |
|
|
257
|
+
|---|---|
|
|
258
|
+
| `cp -p -- "$PWD/package.json" "$backup/project/package.json"` | `cp -p -- "$backup/project/package.json" "$PWD/package.json"` |
|
|
259
|
+
| `cp -p -- "$PWD/package-lock.json" "$backup/project/package-lock.json"` | `cp -p -- "$backup/project/package-lock.json" "$PWD/package-lock.json"` |
|
|
260
|
+
| `cp -p -- "$PWD/robisie.config.json" "$backup/project/robisie.config.json"` | `cp -p -- "$backup/project/robisie.config.json" "$PWD/robisie.config.json"` |
|
|
261
|
+
| `cp -p -- "$config_home/robisie/key" "$backup/robisie/key"` | `cp -p -- "$backup/robisie/key" "$config_home/robisie/key"` |
|
|
262
|
+
| `cp -p -- "$config_home/robisie/manifest.json" "$backup/robisie/manifest.json"` | `cp -p -- "$backup/robisie/manifest.json" "$config_home/robisie/manifest.json"` |
|
|
263
|
+
| `cp -Rp -- "$config_home/robisie/backups/." "$backup/robisie/backups/"` | `cp -Rp -- "$backup/robisie/backups/." "$config_home/robisie/backups/"` |
|
|
264
|
+
| `cp -Rp -- "$config_home/robisie/roles/codex/." "$backup/robisie/roles/codex/"` | `cp -Rp -- "$backup/robisie/roles/codex/." "$config_home/robisie/roles/codex/"` |
|
|
265
|
+
| `cp -p -- "$HOME/.claude.json" "$backup/claude/claude.json"` | `cp -p -- "$backup/claude/claude.json" "$HOME/.claude.json"` |
|
|
266
|
+
| `cp -p -- "$HOME/.claude/agents/ceo-client.md" "$backup/claude/agents/ceo-client.md"` | `cp -p -- "$backup/claude/agents/ceo-client.md" "$HOME/.claude/agents/ceo-client.md"` |
|
|
267
|
+
| `cp -p -- "$HOME/.claude/agents/manager-builder-client.md" "$backup/claude/agents/manager-builder-client.md"` | `cp -p -- "$backup/claude/agents/manager-builder-client.md" "$HOME/.claude/agents/manager-builder-client.md"` |
|
|
268
|
+
| `cp -p -- "$HOME/.claude/agents/quality-officer-client.md" "$backup/claude/agents/quality-officer-client.md"` | `cp -p -- "$backup/claude/agents/quality-officer-client.md" "$HOME/.claude/agents/quality-officer-client.md"` |
|
|
269
|
+
| `cp -p -- "$codex_home/config.toml" "$backup/codex/config.toml"` | `cp -p -- "$backup/codex/config.toml" "$codex_home/config.toml"` |
|
|
270
|
+
| `cp -p -- "$codex_home/AGENTS.md" "$backup/codex/AGENTS.md"` | `cp -p -- "$backup/codex/AGENTS.md" "$codex_home/AGENTS.md"` |
|
|
271
|
+
| `cp -p -- "$config_home/opencode/opencode.json" "$backup/opencode/opencode.json"` | `cp -p -- "$backup/opencode/opencode.json" "$config_home/opencode/opencode.json"` |
|
|
272
|
+
| `cp -p -- "$config_home/opencode/agents/ceo-client.md" "$backup/opencode/agents/ceo-client.md"` | `cp -p -- "$backup/opencode/agents/ceo-client.md" "$config_home/opencode/agents/ceo-client.md"` |
|
|
273
|
+
| `cp -p -- "$config_home/opencode/agents/manager-builder-client.md" "$backup/opencode/agents/manager-builder-client.md"` | `cp -p -- "$backup/opencode/agents/manager-builder-client.md" "$config_home/opencode/agents/manager-builder-client.md"` |
|
|
274
|
+
| `cp -p -- "$config_home/opencode/agents/quality-officer-client.md" "$backup/opencode/agents/quality-officer-client.md"` | `cp -p -- "$backup/opencode/agents/quality-officer-client.md" "$config_home/opencode/agents/quality-officer-client.md"` |
|
|
275
|
+
| `cp -p -- "$config_home/opencode/plugins/robisie-review-guard.js" "$backup/opencode/plugins/robisie-review-guard.js"` | `cp -p -- "$backup/opencode/plugins/robisie-review-guard.js" "$config_home/opencode/plugins/robisie-review-guard.js"` |
|
|
276
|
+
| `cp -p -- "$profile" "$backup/profile/selected"` | `cp -p -- "$backup/profile/selected" "$profile"` |
|
|
277
|
+
| `cp -p -- "$entry_path" "$backup/entries/$entry_id"` | `cp -p -- "$backup/entries/$entry_id" "$entry_path"` |
|
|
278
|
+
|
|
279
|
+
Once the tgz and selected copies are ready, update. Init does not read the key file automatically: ROBISIE_KEY takes priority, then the hidden terminal prompt, then explicit `--key-stdin` (for example automation without a terminal). A key file alone is insufficient. Load the old key BEFORE init/doctor using the same XDG_CONFIG_HOME; separate assignment before export and `&&` retain read failures without printing the key:
|
|
280
|
+
|
|
281
|
+
<!-- update:start -->
|
|
282
|
+
```sh
|
|
283
|
+
set +x
|
|
284
|
+
XDG_CONFIG_HOME="$config_home" &&
|
|
285
|
+
export XDG_CONFIG_HOME &&
|
|
286
|
+
{
|
|
287
|
+
if [ ! -L "$XDG_CONFIG_HOME/robisie/key" ] &&
|
|
288
|
+
[ -f "$XDG_CONFIG_HOME/robisie/key" ] &&
|
|
289
|
+
[ -r "$XDG_CONFIG_HOME/robisie/key" ] &&
|
|
290
|
+
ROBISIE_KEY="$(cat "$XDG_CONFIG_HOME/robisie/key" 2>/dev/null)" &&
|
|
291
|
+
[ -n "$ROBISIE_KEY" ]; then
|
|
292
|
+
export ROBISIE_KEY
|
|
293
|
+
else
|
|
294
|
+
printf '%s\n' 'Cannot load a nonempty regular readable robisie key file.' 'Next step: check the key file and its permissions locally; resolve links/directories without overwriting data. If the key is missing or revoked, use Connect and init with the hidden prompt. Never paste the key into chat.' >&2
|
|
295
|
+
false
|
|
296
|
+
fi
|
|
297
|
+
} &&
|
|
298
|
+
npm i robisie@latest &&
|
|
299
|
+
npx robisie init &&
|
|
300
|
+
npx robisie doctor
|
|
301
|
+
```
|
|
302
|
+
<!-- update:end -->
|
|
303
|
+
|
|
304
|
+
Doctor checks the contract MAJOR; exit 0 also requires its other checks. Choose a compatible release for a mismatch; reinstall damaged package files. Do not repeat the same incompatible installation.
|
|
148
305
|
|
|
149
|
-
|
|
306
|
+
### Return to the previous release
|
|
307
|
+
|
|
308
|
+
Before overwriting, preserve later user edits in a NEW private copy (`umask 077`, e.g. `later="$(mktemp -d "$HOME/robisie-later.XXXXXX")"`). Repeat directory preparation and the left column, substituting `$later` for `$backup`, without altering the original backup. Compare locally and merge user edits with the previous release's copy; configuration can contain a key, so do not publish the diff. Stop overwriting for unreadable configuration, links or an unresolved comparison. There is no promise of automatic rollback.
|
|
309
|
+
|
|
310
|
+
After comparison run the selected right-column commands to the same destinations, honoring absent.txt. Directory rows copy contents through `/.` without nesting another directory; before restore prepare checked destination directories if missing. When merging `backups/` and `roles/codex/`, do not delete additional later files. Restore `package.json` AND `package-lock.json` first. Then in the same cwd load the restored old key into ENV, install the retained compatible tgz, and only then run init and doctor:
|
|
311
|
+
|
|
312
|
+
<!-- restore:start -->
|
|
313
|
+
```sh
|
|
314
|
+
set +x
|
|
315
|
+
XDG_CONFIG_HOME="$config_home" &&
|
|
316
|
+
export XDG_CONFIG_HOME &&
|
|
317
|
+
{
|
|
318
|
+
if [ ! -L "$XDG_CONFIG_HOME/robisie/key" ] &&
|
|
319
|
+
[ -f "$XDG_CONFIG_HOME/robisie/key" ] &&
|
|
320
|
+
[ -r "$XDG_CONFIG_HOME/robisie/key" ] &&
|
|
321
|
+
ROBISIE_KEY="$(cat "$XDG_CONFIG_HOME/robisie/key" 2>/dev/null)" &&
|
|
322
|
+
[ -n "$ROBISIE_KEY" ]; then
|
|
323
|
+
export ROBISIE_KEY
|
|
324
|
+
else
|
|
325
|
+
printf '%s\n' 'Cannot load a nonempty regular readable robisie key file.' 'Next step: check the key file and its permissions locally; resolve links/directories without overwriting data. If the key is missing or revoked, use Connect and init with the hidden prompt. Never paste the key into chat.' >&2
|
|
326
|
+
false
|
|
327
|
+
fi
|
|
328
|
+
} &&
|
|
329
|
+
npm i --no-save "$backup/robisie-$previous_version.tgz" &&
|
|
330
|
+
npx robisie init &&
|
|
331
|
+
npx robisie doctor
|
|
332
|
+
```
|
|
333
|
+
<!-- restore:end -->
|
|
334
|
+
|
|
335
|
+
The `--no-save` option preserves the restored `package.json` and `package-lock.json` without recording a `file:` dependency on the private backup path.
|
|
336
|
+
|
|
337
|
+
Check the status of every separate table command; any error stops the recipe. The chain stops automatically. Never mask reads or combine key assignment with export. On failure preserve both copies and follow doctor before further overwrites.
|
|
150
338
|
|
|
151
339
|
<!-- sekcja: odinstalowanie -->
|
|
152
340
|
## Uninstall
|
|
@@ -156,11 +344,15 @@ npx robisie uninstall
|
|
|
156
344
|
npm uninstall robisie
|
|
157
345
|
```
|
|
158
346
|
|
|
159
|
-
The first command removes robisie entries and blocks from files recorded in the installation manifest and undoes role installation. It does not restore old robisie entries. User-edited roles remain with a warning; backups remain and may contain an old key. Without an installation record the command changes nothing and **does not delete the key file**. A refusal during the Codex configuration check occurs **before key deletion**; after that check the key file is removed even if a later undo fails. A nonzero exit requires preserving your edits and resolving the reported problem before retrying. Open a new terminal. Uninstall does not revoke the key on the server: revoke it separately in Connect. The second command removes the package from the project.
|
|
347
|
+
The first command removes robisie entries and blocks from files recorded in the installation manifest and undoes role installation. It does not restore old robisie entries. User-edited roles remain with a warning; backups remain and may contain an old key. Without an installation record the command changes nothing and **does not delete the key file**. A refusal during the Codex configuration check occurs **before key deletion**; after that check the key file is removed even if a later undo fails. A nonzero exit requires preserving your edits and resolving the reported problem before retrying. Open a new terminal. Uninstall does not revoke the key on the server: revoke it separately in Connect. The second command removes the package from the project and may change `package.json`, `package-lock.json` and `node_modules`; the npm cache may remain. Do not mass-delete those files or the cache. A later npx call may download the package again.
|
|
348
|
+
|
|
349
|
+
Retained backups, including private update copies, may still contain the key after uninstall. Keep them private according to your retention needs; uninstall does not erase or revoke those copies. This guide does not delete them automatically.
|
|
160
350
|
|
|
161
351
|
<!-- sekcja: diagnoza -->
|
|
162
352
|
## Diagnosis
|
|
163
353
|
|
|
354
|
+
Without an installation, begin with the account and Connect → init; repeating doctor does not create an account. With an existing installation, doctor reads the record and key first (ENV takes priority over the file), then checks the network. Resolve record/key-read problems first while preserving data; a network failure on an existing installation does not call for a new account. Check connectivity and server access.
|
|
355
|
+
|
|
164
356
|
CLI messages remain in Polish. Match the message, then follow the English explanation:
|
|
165
357
|
|
|
166
358
|
| ID | CLI message | Next step |
|
|
@@ -168,16 +360,18 @@ CLI messages remain in Polish. Match the message, then follow the English explan
|
|
|
168
360
|
| brak-klucza | `Brak klucza robisie.` | No key: generate one in Connect and supply it to init. |
|
|
169
361
|
| odrzucony-klucz | `Serwer robisie odrzucił klucz (nieważny albo unieważniony).` | Generate a new worker key; in zsh/bash run `unset ROBISIE_KEY`, then init with the hidden prompt. |
|
|
170
362
|
| brak-odczytu | `Ten klucz nie ma uprawnień do odczytu tablicy (np. rola seeder).` | Select worker in Connect; `unset ROBISIE_KEY`, then init with the hidden prompt. |
|
|
171
|
-
| major | `Wersja kontraktu serwera (2.0.0) nie pasuje do paczki robisie 0.1.
|
|
363
|
+
| major | `Wersja kontraktu serwera (2.0.0) nie pasuje do paczki robisie 0.1.3 (obsługuje 1.x).` | Example of a MAJOR mismatch: install a release compatible with the server contract. |
|
|
172
364
|
| brak-env | `Zmienna ROBISIE_KEY nie jest ustawiona — role i agenci jej potrzebują.` | Check profile support; with --no-shell/another shell load the key file into the session environment as shown in init, then doctor. |
|
|
173
365
|
| brak-programu | `katalog jest, programu nie ma w PATH` | Install the named provider program or add it to PATH; a configuration directory alone is insufficient. |
|
|
174
366
|
| brak-programu-i-katalogu | `brak programu w PATH i katalogu dostawcy` | Install the selected program, repeat init with the complete shared map and doctor. |
|
|
175
367
|
| jsonc | `nie zmieniam automatycznie` | Preserve JSONC; prepare supported JSON or choose another provider for all roles. Remote MCP alone is insufficient. |
|
|
176
368
|
| niepelna-instalacja | `Claude Code: niepełna instalacja` | Example of missing configuration: repeat init for your agent. |
|
|
177
369
|
|
|
178
|
-
After repair,
|
|
370
|
+
After repair with an existing record, load the saved key as shown in Update before local `npx robisie init` and `npx robisie doctor`; reinstall missing package files from npm, and obtain a compatible release for MAJOR. For a missing record preserve data and follow doctor instead of blindly running init. If the problem remains, send the team the message, version and cwd without the key. Uninstall success means removed entries and exit 0; exit 1 needs the indicated repair and does not mean complete removal.
|
|
179
371
|
|
|
180
372
|
<!-- sekcja: ograniczenia -->
|
|
181
373
|
## Limitations
|
|
182
374
|
|
|
183
375
|
The installer does not start background services or the Builder on its own; after operator approval, the CEO can start the Builder through `spawn_builder`. Helpers run during agent sessions using the project directory (or `ROBISIE_PROJECT_CONTEXT`) as context. The installer contacts robisie to check the contract and key; the package file does not provide an account or AI provider access. One shared key identity does not provide three different permission levels. Acceptance requires independent review, evidence and the operator's approval.
|
|
376
|
+
|
|
377
|
+
Windows/WSL are unverified. Offline validation checks configuration structure, not project UUID, repo existence, model availability or provider execution.
|