@reminix/cli 1.0.0-rc.13 → 1.0.0-rc.16

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 CHANGED
@@ -2,298 +2,141 @@
2
2
 
3
3
  What changed in the Reminix CLI (`@reminix/cli`). Generated from the source on each release; newest first.
4
4
 
5
- ## 1.0.0-rc.13 (2026-11-18)
5
+ ## 1.0.0-rc.16 (2026-11-22)
6
6
 
7
7
  No user-facing changes.
8
8
 
9
- ## 1.0.0-rc.12 (2026-11-14)
9
+ ## 1.0.0-rc.15 (2026-11-22)
10
10
 
11
11
  ### Added
12
12
 
13
- - The workspace's audit log (`GET /v1/workspace/audit-events`) records
14
- `billing.cancellation_undone` when a plan set to cancel is kept after all.
15
- - The workspace's audit log (`GET /v1/workspace/audit-events`) records more
16
- events. It now includes the workspace's creation and deletion, a declined
17
- invitation, and plan changes: `workspace.created`, `workspace.deleted`,
18
- `workspace.invitation_rejected` and `billing.subscribed`,
19
- `billing.plan_changed`, `billing.cancellation_scheduled` and
20
- `billing.subscription_ended`.
21
- - `GET /v1/workspace/usage` now says where each count stands. Each count
22
- gains `label`, `state` and `stopsAt`, and `unit` when the plan names
23
- one. The response gains a `state` for the whole workspace.
24
- `client.workspace.usage.get()` and the Python client return them. The
25
- CLI's `workspace usage` prints each count as a sentence that says where
26
- it stands. Use `--json` for the response as it is.
27
-
28
- ## 1.0.0-rc.11 (2026-11-13)
13
+ - You can now read one schedule, one trigger or one secret at its own
14
+ address: `GET /v1/scripts/{slug}/schedules/{scheduleId}`,
15
+ `GET /v1/scripts/{slug}/triggers/{triggerId}` and `GET /v1/secrets/{name}`.
16
+ In the SDKs they're `schedules.get`, `triggers.get` and `secrets.get`,
17
+ in the CLI `reminix schedules get`, `triggers get` and `secrets get`, and
18
+ the MCP server has a tool for each. A secret's value is never returned.
19
+ - Everything you create now answers with a `Location` header that gives
20
+ its address: a script, a version, a schedule, a trigger, an environment,
21
+ a file and a run. One version of a script can now be read at
22
+ `GET /v1/scripts/{slug}/versions/{version}` (`scriptVersions.get`).
23
+ - Reminix is here: turn your scripts into tools your team, your software
24
+ and your AI agents can run.
25
+
26
+ Upload a Python, shell or Node script, and Reminix runs it. Start a run
27
+ from a form in the app, from the API or from the CLI. A
28
+ script can also run on a schedule, or when another service calls its
29
+ webhook. Your agents in Claude and ChatGPT can find your scripts and run
30
+ them for you.
31
+
32
+ Each run gets its own isolated machine. Your keys stay out of the code:
33
+ Reminix adds each one only to the hosts you allow, and the script never
34
+ sees it.
35
+
36
+ Where a run needs a person's yes, Reminix asks for it before the run
37
+ starts. Every run is on record, with its inputs, its output and who
38
+ started it.
39
+
40
+ When a run waits for your approval or fails, Reminix tells you in the
41
+ app, by email or with a push notification to your phone.
42
+ - Every TypeScript SDK call now takes a `timeout` in milliseconds and a
43
+ `signal`, for example `client.limits.list({}, { timeout: 2000 })`. The
44
+ timeout covers the whole call, retries and their waits included. Past
45
+ it, the call throws a `TimeoutError` and isn't retried. To set one for
46
+ every call, pass `timeout` to `createClient`.
47
+
48
+ An `ApiError` now carries the response's `headers`, so you can read
49
+ `Retry-After` and the rate-limit headers when a call fails.
29
50
 
30
51
  ### Changed
31
52
 
32
- - Publishing (`reminix publish`, `POST /v1/scripts/{slug}/versions`) now
33
- refuses a command that puts an input inside code given to an interpreter
34
- on the command line, such as `sh -c 'echo {name}'` or
35
- `python -c 'print({name})'`, because the interpreter would run the value
36
- as code. The error shows the safe form, with the input as its own
37
- argument: `sh -c 'echo "$1"' _ {name}`. Versions published before keep
38
- running.
39
- - Triggers have a type. `POST /v1/scripts/{slug}/triggers` takes
40
- `type: "event"` or `type: "webhook"`. An event trigger's `eventType` is
41
- now `event`, and a trigger's `filter` is null for a webhook trigger. A
42
- webhook trigger starts a run when its URL is called with its secret; it
43
- can take inputs from the call (`inputMode`), lock saved inputs
44
- (`lockedInputs`) and check a Stripe or GitHub signature (`signature`,
45
- `signingSecret`). Creating one returns its `url` and `secret`, once.
46
- `POST /v1/scripts/{slug}/triggers/{triggerId}/rotate-secret` gives a new
47
- one, and `GET /v1/scripts/{slug}/triggers/{triggerId}/calls` lists its
48
- recent calls. A run's `via` can now be `webhook`, and a run has
49
- `automationName`, the name of the schedule or trigger that started it. An AI agent can't
50
- create a webhook trigger or rotate its secret. It asks with the approval
51
- actions `trigger.webhook.create` and `trigger.webhook.rotateSecret`, and
52
- a workspace owner approves.
53
+ - Every list command takes `--all`, to print every page instead of the
54
+ first.
55
+
56
+ A list field now takes its flag once for each value, such as
57
+ `--event-type a --event-type b`. Commas work too:
58
+ `--event-type a,b`. A yes-or-no field takes `--x` and `--no-x`, and a
59
+ field you can empty takes `--clear-<field>`.
60
+
61
+ `--base-url`, or the `<NAME>_BASE_URL` variable, points the CLI at
62
+ another API address. They replace `login --api` and `<NAME>_API`.
63
+
64
+ The exit code now says how a command ended: `1` a failure, `2` a wrong
65
+ command or flag, and `4` when you aren't signed in or the API refused
66
+ your token. An error also prints what is wrong with each field and a
67
+ link to its docs, and with `--json` it carries both.
68
+ - `reminix run` takes its inputs the way `gh api` takes fields.
69
+ `-f name=value` gives a text input, and `-F name=value` gives a number,
70
+ `true`, `false`, `null` or JSON. `--input-file` reads the whole object
71
+ from a file, or from standard input with `-`. They replace
72
+ `--input '<json>'`.
73
+ - A request that clashes with what already exists now answers
74
+ `409 conflict`, which was `400 invalid_request`. That covers a script
75
+ slug or an environment name already taken, a field set in the script's
76
+ reminix.json, running an archived script, and cancelling a run that
77
+ has ended. In the SDKs it's a `ConflictError`.
78
+ - Every list now pages the same way. A script's versions, schedules,
79
+ triggers and trigger calls, and the workspace's secrets and environments,
80
+ take `limit` and `cursor` and answer `{ items, nextCursor }`, as runs and
81
+ files already did. A trigger's calls are no longer cut at the last 20.
82
+ - A script's `stats` now name their period in full: `runsLast30Days` and
83
+ `peopleLast30Days`, which were `runs30d` and `people30d`.
84
+ - A secret's value is now saved at its own address:
85
+ `PUT /v1/secrets/{name}/values/{environment}`, the same address that
86
+ removes it. In the SDKs it's `secretValues.set(name, environment, …)`.
87
+ Whether scripts can read a secret as an environment variable is set on
88
+ the secret itself, with `PATCH /v1/secrets/{name}` (`secrets.update`).
89
+ `reminix secrets set` works as before, and `--no-allow-env-var` now
90
+ turns that off again.
91
+ - A file's size is now `sizeBytes`, which was `size`. The file details a
92
+ script reads from its inputs JSON say `sizeBytes` too.
93
+ - Listing a webhook trigger's calls is now `triggerCalls.list()` in the
94
+ TypeScript SDK, `trigger_calls.list()` in Python, `reminix trigger-calls
95
+ list` in the CLI and the `trigger_calls_list` tool in the MCP server. It
96
+ was `triggers.calls`. The route is unchanged.
97
+ - A script's name, description and tags now belong to its `reminix.json`
98
+ when the file sets them. Each upload sets them from the file, and they
99
+ can't be changed in the app or with `PATCH /v1/scripts/{slug}`. The app
100
+ shows such tags as "Set in reminix.json". To change one, edit the file
101
+ and publish again, or remove it from the file to manage it in the app.
102
+
103
+ A script's new `setInFile` field lists the settings its `reminix.json`
104
+ sets.
105
+
106
+ An AI agent changing a script through the MCP server gets the same
107
+ answer.
53
108
 
54
- ## 1.0.0-rc.10 (2026-11-12)
109
+ ## 1.0.0-rc.13 (2026-11-18)
55
110
 
56
- ### Added
111
+ No user-facing changes.
57
112
 
58
- - Members and pending invitations now carry `seat`: the seat type a person
59
- holds or will hold (`GET /v1/workspace/members`,
60
- `GET /v1/workspace/invitations`). It is null for a guest, or where the
61
- product has no seat types.
113
+ ## 1.0.0-rc.12 (2026-11-14)
62
114
 
63
- ### Changed
115
+ No user-facing changes.
64
116
 
65
- - An approval request for a run now has a plain `summary`, such as "Run
66
- refund-customer (version 2) in production", without the run's inputs.
67
- The inputs are in the request's `input` (`GET /v1/approvals/{id}`). Its
68
- `reason` is empty, because Reminix writes none of its own for a run;
69
- the `summary` says what will happen.
70
- - In Reminix a `seat` is `"publishers"` or `"runners"`. An invitation can
71
- choose either.
117
+ ## 1.0.0-rc.11 (2026-11-13)
72
118
 
73
- Only publishers create scripts, upload versions and publish them. A
74
- runner gets `403 forbidden` for those, and so does anyone uploading a
75
- version of a script they can't publish.
119
+ No user-facing changes.
76
120
 
77
- `GET /v1/workspace/usage` no longer has the `authors` count. Seats
78
- replace it.
121
+ ## 1.0.0-rc.10 (2026-11-12)
79
122
 
80
- A workspace keeps up to 1 GB of files on Free, 10 GB on Pro and 100 GB
81
- on Business. An upload past that gets `402 plan_limit_reached`.
123
+ No user-facing changes.
82
124
 
83
125
  ## 1.0.0-rc.9 (2026-11-07)
84
126
 
85
- ### Added
86
-
87
- - Lists can start from a date. `GET /v1/workspace/audit-events` and
88
- `GET /v1/workspace/webhook-endpoints/{endpointId}/deliveries` take
89
- `before`, an ISO time, and return the items older than it, newest first.
90
-
91
- Audit events take two filters. `action` keeps one kind of event.
92
- `actor` keeps what one person, key or token did: pass `user:` and an
93
- item's `actor.id`, or `credential:` and its `credential.id`. Each audit
94
- event now carries those ids.
95
-
96
- Webhook deliveries take `status`: `pending`, `delivered` or `failed`.
97
- - Listing runs takes `status`, which keeps only runs in one state, such as
98
- `failed`. Listing runs and listing files both take `before`, which starts
99
- the list from a moment instead of from now. For example,
100
- `before=2026-11-01T00:00:00Z` lists what came before November.
101
-
102
- ### Changed
103
-
104
- - The usage count `authors` is now described as "People who published or
105
- uploaded this month". Its id and numbers haven't changed.
106
- - Listing files filters by file name with `name`, which replaces `q`. Every
107
- filter is now named after the field it narrows.
127
+ No user-facing changes.
108
128
 
109
129
  ## 1.0.0-rc.8 (2026-11-07)
110
130
 
111
- ### Added
112
-
113
- - `reminix files download <file-id> --json` prints the file's details and
114
- where it was saved, like every other command's `--json`.
115
- - A `run.cancelled` webhook event, sent when a run is cancelled: by
116
- someone (`runs.cancel`), or because its approval was denied, expired or
117
- couldn't start. Its `data` is the same as `run.failed`'s, with `error`
118
- saying why. Triggers can start a script on it.
119
- - Each plan now limits how many runs a workspace has going at once: 1 on
120
- Free, 5 on Pro and 15 on Business, short and long runs together. Of
121
- those, at most 2 can be long runs on Pro and 5 on Business. Starting
122
- one more answers `429 rate_limited` with a `Retry-After` header (a few
123
- seconds for a short run, 30 for a long one) instead of running; the
124
- SDKs and the CLI wait and try again on their own.
125
- - You can now change a webhook endpoint's URL, description or event types
126
- without deleting it: `client.workspace.webhookEndpoints.update()`
127
- (`PATCH /v1/workspace/webhook-endpoints/{endpointId}`). The endpoint
128
- keeps its signing secret, so your verification code keeps working.
129
-
130
- ### Changed
131
-
132
- - An AI agent connected through the MCP server can no longer change who
133
- may run a script or which of its runs need approval:
134
- `PATCH /v1/scripts/{slug}` (`scripts.update`) answers `403 forbidden`
135
- when an agent's token sends `access`, `teamIds` or `approvalPolicy`.
136
- People's own tokens and API keys change them as before. And with
137
- `approvalPolicy: "always"`, an agent's run now always waits for
138
- approval, even when an owner or admin connected the agent.
139
- - An approval request (`POST /v1/workspace/approval-requests`) now runs in
140
- the environment it was filed in once a person approves it, such as live
141
- when you asked from live. Before, it ran in the default environment
142
- unless its input named one. Requests filed before this change still
143
- run in the default.
144
- - The descriptions of every method and command are rewritten to be easier
145
- to read: one rule per sentence, with nothing about how calls behave
146
- changed. They now also say that only workspace owners can manage webhook
147
- endpoints with a personal access token.
148
- Every response in the API reference now comes with an example of what
149
- it returns.
150
- - Error messages and CLI output read as whole sentences: what went wrong,
151
- then what to do. For example, an unknown environment now says
152
- `Unknown environment "staging". This product's environments are test, live.`
153
- Error codes are unchanged, so code that checks `error.code` keeps
154
- working. Code that matches the exact text of a message may need
155
- updating.
156
- - One name per idea, across the API, the SDKs, the CLI and MCP (breaking,
157
- before 1.0):
158
-
159
- - Upload a version is `scriptVersions.upload` (`script_versions.upload`
160
- in Python), and takes `source` (was `archive`), `install` (was
161
- `build`), `timeoutSeconds` (was `timeout`) and `envVars` (was `env`).
162
- A version answers with `version` (was `number`), `install`,
163
- `installLog`, `buildBytes`, `buildSha256`, `envVars` and `via` (was
164
- `createdVia`); version paths are `/versions/{version}`.
165
- - Test-run a version is `scriptVersions.testRun` (`test_run`).
166
- - A run has `via` (was `interface`; an agent's runs are `agent`, was
167
- `mcp`) and `startedBy: { userId, name, credential: { type, name } }`.
168
- Its log is `runs.log` at `GET /v1/runs/{runId}/log` (was `runs.logs`,
169
- `/logs`). The 202 schema is `RunAwaitingApproval` (was `HeldRun`).
170
- - A file has `origin` (`input` or `saved`, was `direction` `in`/`out`),
171
- `input` (was `field`) and `mediaType` (was `type`); list files with
172
- `?origin=`. `files.upload` and `files.download` (at
173
- `GET /v1/files/{fileId}/download`) replace `files.create` and
174
- `files.content`. The SDKs' `FileUpload` takes `mediaType`
175
- (`media_type` in Python). A script saves files to `/saved`
176
- (`$REMINIX_SAVED`, was `/outputs`), and reads its inputs file at
177
- `$REMINIX_INPUTS_FILE` (was `$REMINIX_INPUTS`).
178
- - Secrets: `allowEnvVar` (was `allowEnv`; the CLI's `--allow-env-var`),
179
- a secret use's `format` (was `value`), and `secretValues.delete`
180
- (`reminix secret-values delete`, was `secrets.unset`).
181
- - Triggers have `lastRunAt` (was `lastFiredAt`); a script's
182
- `usedBy.startsScripts` was `followedBy`; an environment's `usedBy` was
183
- `usage`. The event `run.succeeded` was `run.completed`. Script ids
184
- start `scr_`.
185
- - The CLI: `reminix upload [dir...]` uploads a draft (`publish --draft`
186
- is gone), and `--dry-run` replaces `--plan`.
187
- - Path parameters such as `endpointId` and `deliveryId` now come with a
188
- description ("The endpoint's ID.") in the SDKs' type hints, the
189
- command line's help and the API reference.
190
- - `login` and `logout` now point to **Account → Personal access tokens**,
191
- the page's new name in the app (it was "API tokens").
192
- - The API reference's "Too many requests" answer now gives the limit: 100
193
- requests a minute for each credential, whether an API key, a personal
194
- access token or an agent's sign-in. Wait the number of seconds in the
195
- `Retry-After` header before trying again.
196
- - Method and command descriptions are clearer, and say who can call each
197
- one. A workspace API key's access to updating, archiving, restoring and
198
- test-running scripts is now stated. The CLI's `reminix publish`,
199
- `reminix upload` and `reminix run` shortcuts describe themselves the
200
- same way as the full commands.
201
- - Error messages are easier to read. Each one states the problem in one
202
- sentence, then what to do in the next:
203
-
204
- ```text
205
- SHOP_KEY has no value in staging. Add it in Settings → Scripts.
206
- ```
207
-
208
- If your code matches the text of an error, match its `code` instead.
209
- The codes haven't changed.
210
- - Environments and secrets now live under **Settings → Scripts** in the
211
- app. A run error that sends you to the app to fix a secret or an
212
- environment now names that tab.
213
- - A run's `output`, `error` and log (`GET /v1/runs/{id}`,
214
- `GET /v1/runs/{id}/log`) never show a secret value the run had access
215
- to: printed as it is, or base64- or URL-encoded, it reads `[secret]`.
216
- - API keys and webhooks now live together under **Settings → Developers**
217
- in the app, and the descriptions of the API key and webhook endpoint
218
- operations point there.
219
- - `POST /v1/scripts/{slug}/runs` no longer fails a run because no machine
220
- was free at once: the run waits up to 2 minutes for one, and its
221
- `timeoutSeconds` counts from when its code starts. A short run still
222
- answers `200` when it ends within 60 seconds; one still going then
223
- answers `202` with status `running`, like a long run, and you follow it
224
- with `GET /v1/runs/{id}`.
225
- - `GET /v1/workspace/usage` returns its list as `counts` instead of `meters`.
226
- Update anything that reads `meters` from `client.workspace.usage.get()`, the
227
- Python client or the CLI's output.
228
-
229
- ### Fixed
230
-
231
- - `files.upload` refuses a file over the plan's size with `402
232
- plan_limit_reached`, naming the plan's limit, on every plan. On Pro and
233
- Business a file just over 100 MB used to get a generic `413` instead.
234
- - Clearer, corrected descriptions for Reminix's operations in the API
235
- reference, the SDKs' type hints, the command line's help and the MCP
236
- tools:
237
-
238
- - `runs.create` (and `scriptVersions.testRun`) documents its 429: 100
239
- requests a minute per key or token, or the plan's runs at once all
240
- going. Its 402 now also names used-up long-run minutes and a file
241
- input larger than the plan takes, and its 400 an archived script. A
242
- run takes at most its version's `timeoutSeconds`, not always 30.
243
- - `runs.cancel` says a cancelled run sends a `run.cancelled` event, and
244
- that a workspace API key may cancel too.
245
- - `files.upload` documents its 413: uploads over 1,000 MB are refused.
246
- An upload can be given to one run.
247
- - `files.get`: an upload not yet used is also readable by owners,
248
- admins and workspace API keys.
249
- - `scripts.update`: its 402 is about every-run approval (Business), and
250
- it changes tags too. `scriptSettings.update`: its 402 is about
251
- second-person publishing (Business).
252
- - `schedules.update` and `triggers.update`: `enabled` no longer claims a
253
- default; leaving it out keeps it as it is.
254
- - Name rules are given where they are checked: a script's `slug`, its
255
- tags, an environment's `name`, a secret's `name`, and a secret's
256
- `value` (at most 16,384 bytes).
257
- - A run that waited for approval now reports when it actually started:
258
- its `startedAt` (`GET /v1/runs/{id}`, and a run wherever the SDKs and
259
- the CLI show one) is when it was approved, not when it was requested, and a cancelled long run's
260
- `durationMs` counts only the time it ran, never the wait.
131
+ No user-facing changes.
261
132
 
262
133
  ## 1.0.0-rc.7 (2026-10-19)
263
134
 
264
- ### Changed
265
-
266
- - - `reminix run` waits through a person's approval, as the SDKs' `run`
267
- does: it prints where to approve the run, then follows it to the end.
268
- `--no-wait` answers at once instead.
269
- - A cancelled run says why, in every client: "Run run_… was cancelled:
270
- The approval was denied" (the run's `error`). The CLI no longer prints
271
- "failed: null".
272
- - Files are uploaded without a guessed type; the API takes it from the
273
- file's name, the same way for every client. `reminix run --file` no
274
- longer reads the script first: one file is sent as one id, and the API
275
- takes it for an input that is a list of files.
276
- - Publishing is one call. `scriptVersions.create` (Upload a version)
277
- takes `create`, `name`, `description` and `publish`: it can make a new
278
- script, rename one, and publish the upload, answering with an
279
- `approval` link when a person must approve. Without `readme`, the
280
- folder's `README.md` is used. `reminix publish` uses it, so a name or
281
- description changed in `reminix.json` now reaches the script.
282
- - `reminix init` works out the command the same way `publish` does, so
283
- the two agree on every folder (an entry like `main.py` beside other
284
- scripts, `pyproject.toml`, `package.json`).
135
+ No user-facing changes.
285
136
 
286
137
  ## 1.0.0-rc.6 (2026-10-19)
287
138
 
288
- ### Fixed
289
-
290
- - `login` in the browser no longer shows Safari's "This is a non-secure
291
- form" warning after **Allow**. The page now hands the new token back to
292
- the waiting CLI encrypted to a key only that CLI holds, by a redirect
293
- instead of a form. A CLI from before this change is asked to update.
294
- - `reminix run <slug> --number <n>` test-runs version n (a draft).
295
- `--version <n>` printed the CLI's own version instead of running, so it
296
- is gone. A run whose output is text prints it as it is, without quotes.
139
+ No user-facing changes.
297
140
 
298
141
  ## 1.0.0-rc.5 (2026-10-16)
299
142
 
@@ -301,13 +144,7 @@ No user-facing changes.
301
144
 
302
145
  ## 1.0.0-rc.4 (2026-10-16)
303
146
 
304
- ### Added
305
-
306
- - Each release comes with a `CHANGELOG.md` listing what changed, newest first.
307
-
308
- ### Changed
309
-
310
- - The package page (README, on GitHub, npm and PyPI) shows what the product does with a first real example, and links the guide, the API reference, the changelog and support.
147
+ No user-facing changes.
311
148
 
312
149
  ## 1.0.0-rc.3 (2026-10-16)
313
150
 
package/README.md CHANGED
@@ -22,8 +22,8 @@ Or run it without installing: `npx @reminix/cli --help`.
22
22
  reminix login
23
23
  ```
24
24
 
25
- Your browser opens: sign in, choose the workspaces the CLI may use, and
26
- click **Allow**. On a server or in CI, set `REMINIX_TOKEN` to a personal
25
+ Your browser opens: sign in, choose the workspaces the CLI may use, keep
26
+ the access at **Publish and run scripts**, and click **Allow**. On a server or in CI, set `REMINIX_TOKEN` to a personal
27
27
  access token instead.
28
28
 
29
29
  ## Publish a script and run it
@@ -40,7 +40,7 @@ Then anyone on the team can run it from the app's form, through the
40
40
  API, as an agent tool, or here:
41
41
 
42
42
  ```bash
43
- reminix run monthly-report --input '{"month":"2026-09"}' --out ./reports
43
+ reminix run monthly-report -f month=2026-09 --out ./reports
44
44
  ```
45
45
 
46
46
  ## Everything else