instabox 0.8.273 → 0.8.275
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/cli/SHA256SUMS +6 -6
- package/cli/instabox-darwin-amd64 +0 -0
- package/cli/instabox-darwin-arm64 +0 -0
- package/cli/instabox-linux-amd64 +0 -0
- package/cli/instabox-linux-arm64 +0 -0
- package/cli/instabox-windows-amd64.exe +0 -0
- package/cli/instabox-windows-arm64.exe +0 -0
- package/package.json +3 -2
- package/skills/instabox/SKILL.md +18 -3
- package/skills/instabox-snapshots/SKILL.md +1 -0
package/cli/SHA256SUMS
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
27d15ba6008b7ede595b177491a4acc71c82838057bb32eb7f6c98f154f84a7e instabox-darwin-amd64
|
|
2
|
+
82c0acc4a698c537888b088df09083743de84a4d7572879605de06f6a1b100e2 instabox-darwin-arm64
|
|
3
|
+
858ddf00c7fff9f9651b28458ed786dfb1567d5ed0fdb981bdb39f5f81e03186 instabox-linux-amd64
|
|
4
|
+
3cd9b2a1acadcdfa3697f260785b163bf6d5febf638c84830118768cb9ebc669 instabox-linux-arm64
|
|
5
|
+
006adccc72c09ec9e87af336f615c284f921b2db65ddfb2de358469d6dae1c61 instabox-windows-amd64.exe
|
|
6
|
+
ead60bb974d2535652649623bf64024153745a238dba845dbcb9f92adb75e742 instabox-windows-arm64.exe
|
|
Binary file
|
|
Binary file
|
package/cli/instabox-linux-amd64
CHANGED
|
Binary file
|
package/cli/instabox-linux-arm64
CHANGED
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "instabox",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.275",
|
|
4
4
|
"description": "A cloud box for your coding agent, the instabox CLI and its agent skills in one command: npx instabox@latest",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -30,5 +30,6 @@
|
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
32
|
"prettier": "3.9.9"
|
|
33
|
-
}
|
|
33
|
+
},
|
|
34
|
+
"gitHead": "d49739c393271f7854762abb1d7eeb90031650b3"
|
|
34
35
|
}
|
package/skills/instabox/SKILL.md
CHANGED
|
@@ -101,7 +101,7 @@ instabox rm --yes work # delete the box (without --yes
|
|
|
101
101
|
- Disk full (`df -h /data`)? Grow it with `instabox resize <box> --disk N` (`/data`, where HOME is), in GB. A running box grows online, no restart. A shrink, a paused box, or an image that can't grow online needs `--restart` (it stops the box, resizes the disk and starts it again; files stay, processes do not), else resize changes nothing and says so. A shrink must fit your data plus 10% (at least 1 GB), else it's refused (`disk_too_small`) and nothing changes. Free-plan boxes keep their size. The system disk (`/`) is the template's; you can't grow it.
|
|
102
102
|
- Need more CPU or memory? A paid box moves to another of its plan's sizes with `instabox resize <box> --vcpus N --mem-mib M` (Pro: 2/4096, 4/8192, 8/16384; Builder: 2/4096 up to 16/32768; Team: 2/4096 up to 32/65536), while it is stopped; add `--restart` on a running box, and run that from outside the box (from inside, the stop would end the command before the start, so resize refuses it; the same goes for a shrink with `--restart`). A size the plan does not have is refused before anything stops. The new size applies at the next start; free-plan boxes keep theirs.
|
|
103
103
|
- Use `exec` to run a command and read its output, and `ssh` for an interactive shell.
|
|
104
|
-
- Use `cp`, `push` and `pull` to move files, not `echo <base64> | base64 -d` over `exec`. `cp LOCAL work:PATH` and `cp work:PATH LOCAL` copy either way (`-r` for directories). `push work LOCAL [REMOTE]` copies a file or directory to REMOTE (default: HOME); an existing directory or a path ending in `/` receives it under its own name. REMOTE's parent directory must exist (else `missing_parent`); `-p` creates it. A file streams byte-for-byte, up to 5 GiB, and its sha256 is checked; a directory goes as a gzipped tar of at most 1 GiB. From inside a git repo, a directory push sends only tracked files (`git ls-files -c`); `--all` adds untracked files git does not ignore; `node_modules`, build output and `.git` stay behind. `pull work REMOTE [LOCAL]` copies back the same way: a file streams, any size; a directory is read as root, at most 32 MiB
|
|
104
|
+
- Use `cp`, `push` and `pull` to move files, not `echo <base64> | base64 -d` over `exec`. `cp LOCAL work:PATH` and `cp work:PATH LOCAL` copy either way (`-r` for directories). `push work LOCAL [REMOTE]` copies a file or directory to REMOTE (default: HOME); an existing directory or a path ending in `/` receives it under its own name. REMOTE's parent directory must exist (else `missing_parent`); `-p` creates it. A file streams byte-for-byte, up to 5 GiB, and its sha256 is checked; a directory goes as a gzipped tar of at most 1 GiB. From inside a git repo, a directory push sends only tracked files (`git ls-files -c`); `--all` adds untracked files git does not ignore; `node_modules`, build output and `.git` stay behind. `pull work REMOTE [LOCAL]` copies back the same way: a file streams, any size; a directory is read as root, at most 5 GiB compressed (past 32 MiB its archive is packed in the box's `/tmp` and streamed). Over HTTP: `PUT /v1/machines/{id}/files?path=P` with the raw body, `GET /v1/machines/{id}/files/content?path=P`, and `POST /v1/machines/{id}/files/upload-url` for a signed URL that takes the PUT without a key.
|
|
105
105
|
- `exec` with one argument after `--` runs it as a shell string (`instabox exec work -- 'ls | wc -l'`); several arguments run as that exact argv, each quoted for you (`instabox exec work -- bash -c 'echo a b > /tmp/x'`). Always put `--` right before the command, with exec's own flags (`--cwd`, `--timeout`, `--json`, ...) before it: without it, the command's words that start with `-` are read as exec's flags, up to the command's own `--` if it has one (`instabox exec work unshare --mount -- python3` fails with `--mount is not an exec flag`, and `instabox exec work ls --json` takes `--json` for exec).
|
|
106
106
|
- For a one-off job that needs no box afterwards, use `instabox run [--template T | --from SNAPSHOT] [--name N] [--push DIR] [--cwd D] [-e K=V ...] [--timeout 60s] [--keep] [--setup-file PATH|-] [--json] -- <cmd...>` instead of create + exec + rm: it deletes the box even when the command fails or the run is interrupted (Ctrl-C, SIGTERM), and exits with the command's code (124: timed out). Its own failures have their own codes: 2 usage, 75 `--fail-fast` and no host has room (retry later), 125 `run` itself failed (API, network, create, upload or cleanup), 130 interrupted; with `--json` they print the `{"error": {...}}` object, except a failed cleanup delete: the result then has `deleted: false` and `cleanup: {"error": {...}}` (stdout is always one JSON document). One argument is a shell string, several an exact argv. The same 10-minute limit as `exec` applies. `--push .` first uploads the current directory's files (those git does not ignore) into the working directory (`--cwd`, default HOME), so `instabox run --push . -- 'go test ./...'` tests your checkout. `--name N` is used as is (1-63 lowercase letters, digits or `-`, starting with a letter or digit; default `run-<8 hex digits>`). A box left behind by a killed CLI is deleted by the server at its `deleteAt`, 5 minutes after its timeout (10 with `--push`, plus another timeout with `--setup-file`); a cleanup delete that gets a 5xx, a retryable error or no answer is retried 5 times with backoff. `--setup-file PATH|-` runs a setup script (at most 64 KB) first, in HOME with the same `--timeout` and `-e` variables (after `--push`); if it fails, `run` exits with its code without running the command. `--keep` keeps the box with no deadline and, once it was created, prints `Kept NAME; delete it with: instabox rm --yes NAME` to stderr (stdout stays the command's; `--json` has it as `sandbox`); a failed create operation prints only its error (one whose wait was cut short is kept, with `Kept NAME, whose create had not finished; …`).
|
|
107
107
|
- `instabox ps work [--all] [--json]` lists the processes running in the box (the server runs `ps` through exec, so it wakes a box that paused itself). Kernel threads and the listing's own processes (its shell, `ps`, `head` and the sshd sessions exec uses) are left out unless `--all`. `--json` prints an array of `{pid, ppid, user, cpuPercent, memPercent, elapsedSeconds, command}`: `instabox ps work --json | jq '.[] | select(.command | test("node"))'`. A stopped or manually paused box shows the list the server read just before it stopped or paused (a stderr note says when it is from), so you can see what was running when a box went down; a box that was never listed while running says so and asks you to start it.
|
|
@@ -111,7 +111,7 @@ instabox rm --yes work # delete the box (without --yes
|
|
|
111
111
|
- For work past 600 s, or to keep going while you do something else, start a background job: `instabox exec --background work -- 'npm run build'` prints a job ID at once (`--json`: `{jobId, pid}`); then `instabox jobs ls work`, `instabox jobs logs work <job> -f` (streams until it ends, exits with its code; Ctrl-C leaves the job running), `instabox jobs wait work <job> [--timeout 30m]` and `instabox jobs kill work <job> [--signal KILL]` (the whole process group). This is the CLI polling over plain exec calls. A job holds no activity lease: only its CPU use, or a running `jobs wait`/`logs -f`, counts as activity, so keep `jobs wait` going for a quiet job you need to finish. A pause freezes the job and it carries on after resume; a stop ends jobs (`exited(143)`, or `lost` after a hard stop).
|
|
112
112
|
- To hand a task to a coding agent inside the box, use `instabox agent`: `instabox agent prompt work [--provider claude|codex] [--model M] [--new | --resume ID] [--attach FILE] [--cwd D] [--env K=V] [-f] [--json] "text"` starts a turn as a background job (`claude -p --output-format stream-json` or `codex exec --json`, permission prompts and sandboxing skipped: the box is the boundary) and prints the conversation ID (`--json`: `{conversationId, turn, jobId, pid}`; `-f` follows the turn and exits with its code). `instabox agent events work [-c ID] [-f] [--json]` prints the conversation's events, one JSON object per line: the agent's own, between `instabox.turn` (with the prompt) and `instabox.turn_end` (`exitCode`, `interrupted`). `instabox agent steer work [-c ID] "text"` interrupts the running turn, if any, and resumes the agent's session with the text; `instabox agent interrupt work [-c ID]` stops the turn (INT, then TERM, then KILL); `instabox agent ls work [--json]` lists conversations (status `running`, `idle`, `interrupted`, `failed(N)` or `lost`). Without `-c`, the conversation prompted last. The agent needs its key in the box's environment: `ANTHROPIC_API_KEY` (or `CLAUDE_CODE_OAUTH_TOKEN`) for claude, `OPENAI_API_KEY` (or `CODEX_API_KEY`) for codex, from an org Secret the box selects, or `--env`; the CLI warns when none is set. When the template lacks the agent CLI, the first turn installs it with npm into `~/.instabox/agent-cli` (an `instabox.install` event), or fails with an `instabox.error` event when there is no npm. State lives in `~/.instabox/agents/<id>` in the box. A turn waiting on the model API looks idle to auto-suspend (network does not count), so keep `agent events -f` (or `prompt -f`) going for a long turn you need to finish.
|
|
113
113
|
- A box that does not boot, is unreachable, or failed to start or resume: `instabox logs work` prints its console log (kernel and systemd boot messages) and its last 20 operations with their errors, in any state, without waking it. Add `-f` to follow it or `--json` for `GET /v1/machines/{id}/logs`.
|
|
114
|
-
- Output: `--json` (or `-o json`) works on every command (each command's `-h` lists it); the only exceptions are `ssh`, `mosh` and `port-forward`, which are interactive and refuse it with the JSON error code `json_unsupported` (use `exec --json`). With JSON output a failure prints `{"error":{"code","message",...}}` on stdout
|
|
114
|
+
- Output: `--json` (or `-o json`) works on every command (each command's `-h` lists it); the only exceptions are `ssh`, `mosh` and `port-forward`, which are interactive and refuse it with the JSON error code `json_unsupported` (use `exec --json`). With JSON output a failure prints `{"error":{"code","message",...}}` on stdout and one line `instabox: error CODE: MESSAGE` on stderr, and still exits non-zero (2 for usage errors, code `usage`); API errors keep the server's `code`, `status`, `requestId` and `retryable` (present when true). Piped, the list and status commands (`ls`, `get`, `templates`, `usage`, `snapshot ls`, `port ls`, `keys ls`, `secrets ls`, `vault ls`, `workspace ls|get|members|invites`) print JSON on their own, so `instabox ls | jq` works; `--output table` or `INSTABOX_NO_AUTO_JSON=1` keeps the table. `exec`, `ssh`, `files` and the other commands print the same output piped or not.
|
|
115
115
|
- Exit codes: a failed command exits 1 for any other error, 2 usage, 3 auth (not signed in, a bad or expired key, no permission: 401/403), 4 not found (404), 5 quota or plan limit (`quota_exceeded`, `credit_exhausted`, `spend_limit_reached`, `spec_not_allowed`, other 402/429), 6 `create --ready-timeout` passed (`create_timeout`: the box was not ready in time; `deleted` says whether it was deleted), 75 retryable (`retryable: true`, such as `no_capacity` and `host_unavailable`, or another 5xx; retry with backoff; except `restart` on a box restarting itself after a reboot inside it: nothing to do, do not rerun `restart`). `--json` errors exit the same way. Commands that run something (`exec`, `ssh`, `jobs wait`, `output`, `run`, ...) exit with its code instead. Branch on the code (`case $? in 4) ...`), not on message text.
|
|
116
116
|
- The box's HOME has `MACHINE.md` (which box it is, its size, what survives a stop, the installed tools) and `AGENTS.md`, a moment after it starts. They are reference for when a task needs a fact about the box, not steps to run first.
|
|
117
117
|
- A public URL for a web server in the box: `instabox port publish work 3000` prints it (`instabox port ls`, `instabox port unpublish work 3000`). The URL works while the box runs. A request wakes a box that paused itself for being idle; a box you paused or stopped answers `503` (Sandbox offline) until you `instabox resume` or `instabox start` it.
|
|
@@ -215,9 +215,24 @@ instabox feedback --json --type bug --component cli --area exec \
|
|
|
215
215
|
|
|
216
216
|
- `--type`: `bug` when something does not work as its help or the docs say (when instructions did not match reality, also give `--doc`, `--expected` and `--workaround`), `feature-request` when what you need is not supported, `friction` when it works but is confusing or awkward, `other` otherwise.
|
|
217
217
|
- `--component`: `cli`, `api`, `sandbox` (the box itself, its templates or tools), `dashboard`, `skills`, `docs` or `other`. `--severity blocker|major|minor` (default `minor`); `--sandbox NAME` names the box involved.
|
|
218
|
-
-
|
|
218
|
+
- Signed in, the report opens a support ticket on the account, and the team's replies show in the dashboard at the link it prints (`ticket` in `--json`); signed out or waitlisted, it reaches the team without one.
|
|
219
219
|
- A failed or unconfirmed submission prints a warning and exits 0: do not retry. File one report per problem, not one per attempt.
|
|
220
220
|
|
|
221
|
+
### Redaction: what never goes into a report
|
|
222
|
+
|
|
223
|
+
The report leaves the user's machine and is read by the instabox team. It is about instabox, not about the user. Before every `instabox feedback`, write each field by these rules, then reread every field once more and remove anything that breaks one. They are not optional, and the CLI's own scrubbing (below) does not replace them.
|
|
224
|
+
|
|
225
|
+
- Describe what instabox did, not what the user asked you to do: never quote or paraphrase their task, prompt or conversation (not "the user asked me to deploy the acme-billing migration", but "while running a database migration in a box").
|
|
226
|
+
- Never include, in any field: the user's name, username or login, email address, hostname or computer name, `DOMAIN\user`, their company, team, customer or repository names, the names of their files or branches, their code or file contents, environment variable values, IP addresses, internal URLs or domains, or any key, token, password or cookie, even a partial or expired one.
|
|
227
|
+
- Paths: never a local absolute path, and a path at all only when it is the point. Write the user's home as `~` and the project root as `<repo>` (`~/.config/instabox/` is fine: it is instabox's own directory). Paths inside a box (`/data`, `/data/home`, `/data/workspace/<repo>`) name instabox's layout and may stay, with any repository name replaced by `<repo>`.
|
|
228
|
+
- Commands and output: keep the `instabox` command and the part of its output that shows the problem. Replace every other identifying value with a placeholder, `<user>`, `<host>`, `<repo>`, `<box>`, `<email>`, `<key>`, `<url>`, and trim output to the lines that matter. Never paste a whole log, a stack trace from the user's code, a shell prompt (it carries the username and hostname), `whoami`, `hostname`, `env` or `git config` output.
|
|
229
|
+
- `--sandbox` and box names may be sent as they are: they name the instabox resource. When a box's name contains the user's name or username, or a repository, company or customer name, write `<box>` instead, in `--sandbox` too: the CLI sends `--sandbox` as given.
|
|
230
|
+
- When a detail cannot be described without one of these, describe it generically ("a path with a space in the username", "a Windows home directory") instead of quoting it, or leave it out.
|
|
231
|
+
|
|
232
|
+
Example: not `--detail "C:\Users\Jane Doe\acme-api> instabox exec dev -- npm test failed for jane@acme.com"`, but `--detail "from a Windows home whose username has a space (~\<repo>), instabox exec dev -- npm test failed"`.
|
|
233
|
+
|
|
234
|
+
What the CLI scrubs on its own, as a last line of defense and never as the reason to skip the rules: the current computer's usernames and, outside a box, its home directory and hostname, wherever they appear except in `--sandbox` (`<user>`, `~`, `<host>`; very short or common names such as `root` are left alone), plus anything shaped like an email address, a key or token, a `password=` value, a URL's credentials, a home path (`/home/x`, `/Users/x`, `C:\Users\x`) or a public IPv4 address. It cannot know names, repositories, code or anything else about the user.
|
|
235
|
+
|
|
221
236
|
## Habits
|
|
222
237
|
|
|
223
238
|
- Forgotten boxes pause themselves after 30 idle minutes. Delete a box with `instabox rm --yes NAME` once its work is done. `rm`, `snapshot rm`, `secrets rm`, `vault rm`, `keys rm` and `webhooks rm` ask y/N first and, off a terminal with no answer, delete nothing and fail, so pass `--yes` (`-y`).
|
|
@@ -17,6 +17,7 @@ instabox snapshot save work --name work-ready --description "deps installed, rep
|
|
|
17
17
|
|
|
18
18
|
- A running box is saved live, without stopping it: the snapshot is `pending` in `instabox snapshot ls` until its disks finish uploading (`--no-wait` returns at once).
|
|
19
19
|
- Do not stop the box first: `stop` ends every process in it. A live snapshot is like a clean power cut: what is on disk is kept, what programs hold only in memory is not. Only if the server answers that this box must be stopped, or if a program must write its data to disk first (a database mid-write), run `instabox stop work`, save, then `instabox start work`.
|
|
20
|
+
- A running GPU box is never saved live: the save answers `409 operation_conflict` ("stop it first"). `instabox snapshot save work --name work-ready --restart` stops it, saves it and starts it again (also after a failed save), one stderr line per step; its processes must be started again afterwards. `--restart` never stops a box the server saves live.
|
|
20
21
|
- `--root-only` saves just the root disk (smaller; `/data` is not included).
|
|
21
22
|
- A disk snapshot includes credential files written by applications, tool sign-ins, and historical Vault files; a suspend snapshot can also retain credentials in process memory. Org Secrets reach the box only as placeholders, so a snapshot holds none of their values, but anything an app or a person wrote to disk is kept. Do not describe snapshots as credential-free. Review copied credentials and rotate upstream when required before sharing or retaining them.
|
|
22
23
|
- Pick names that say what is inside (`node20-playwright`, `api-db-seeded`); names must be unique among your snapshots.
|