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

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