@reminix/cli 1.0.0-rc.1 → 1.0.0-rc.11

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