@reminix/cli 1.0.0-rc.12 → 1.0.0-rc.15

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