reminix login CLI
The Reminix command-line interface (CLI) lets you publish your scripts for your team and run them, from a terminal or from another script. It acts as you, in the workspaces you allow.
Install
Section titled “Install”npm install -g @reminix/cliSign in
Section titled “Sign in”reminix loginYour browser opens. Sign in, choose which workspaces the CLI may use and
what it may do, then click Allow. The CLI creates a personal access
token for this computer and stores it in ~/.config/reminix/. The token
lasts 90 days. You’ll find the token under
Account → Personal access tokens.
On a server or in CI there’s no browser, so pass a token instead. If you
set it in the environment, the CLI writes nothing to disk.
reminix login --token saves the token the same way a browser sign-in
does:
REMINIX_TOKEN=pat_… reminix whoamireminix login --token "$TOKEN" # or: echo "$TOKEN" | reminix loginreminix logout revokes the token and forgets it.
Common tasks
Section titled “Common tasks”To publish monthly-report for your team, run this in its folder:
reminix publishReminix works out how to run the script from the files in the folder.
To give the script inputs, tell Reminix how to run it. Each {name} in
the command becomes an input, and an input inside [ … ] is optional:
reminix publish --command "python report.py [--month {month}]"To keep the command in the folder, along with settings such as a form’s
labels, hosts and secrets, run reminix init. It writes a
reminix.json for you to edit:
reminix init "python report.py [--month {month}]"You can also upload a draft, try it, then publish that same version. Upload makes a new draft version. Publish makes a version the one that runs use:
reminix upload # Uploaded monthly-report version 1 as a draft.reminix run monthly-report --number 1 --input '{"month":"2026-09"}' --logreminix publish --number 1 # publishes version 1, uploading nothing--number picks a version. The flag isn’t --version, because
--version prints the CLI’s own version. --dry-run shows what
upload or publish would send, without sending anything.
To publish several scripts at once, name their folders, or a folder that holds them. Each script publishes on its own. If one fails, the rest still publish, and the command exits with an error that names the one that failed.
reminix publish scripts/monthly-report scripts/nightly-syncreminix publish scripts/ # every subfolder that is a scriptA subfolder counts as a script when it has a reminix.json, or when
Reminix can tell how it runs (Scripts explains how).
The command skips other subfolders and lists the ones it skipped. A
folder with its own reminix.json, pyproject.toml or package.json
is one script, even if it has subfolders.
Run the published script, give its file input a file, and download the CSV file it saves:
reminix run monthly-report --input '{"month":"2026-09"}' \ --file adjustments=./adjustments.csv --out ./reportsIf a run needs a person’s approval, run prints where to approve it. It
then follows the run to its end, as the SDKs do. If the approver denies
the run, the command exits with an error saying why. Pass --no-wait
to return straight away instead.
Run the script at 8:00 on the 1st of every month, for the month before:
reminix schedules create monthly-report --name "First of the month" \ --cron "0 8 1 * *" --timezone Europe/LondonSee recent runs and a run’s log:
reminix runs list --script monthly-report --limit 10reminix runs log run_123Choose a workspace
Section titled “Choose a workspace”reminix workspace listreminix workspace use acme # the default for later commandsreminix workspace audit-events list --workspace other-co # one call elsewhereChoose an environment
Section titled “Choose an environment”If your workspace has two or more environments, a command acts in the workspace’s default environment unless you name another. Every command prints the environment it used to stderr.
reminix run monthly-report --environment staging # one callreminix environment use staging # the default for later commandsreminix environment unset # back to the workspace's defaultREMINIX_ENVIRONMENT=staging reminix secrets listThe CLI uses the first of these that’s set:
- the
--environmentflag - the
REMINIX_ENVIRONMENTvariable - the environment you chose with
reminix environment use - the workspace’s default
The environments commands are different. An owner or admin uses them
to manage the workspace’s environments: reminix environments list,
create, update and delete.
Commands
Section titled “Commands”The commands come in groups, by what they work on:
reminix scripts listreminix scripts get monthly-reportreminix runs list --script monthly-report --limit 10reminix schedules delete monthly-report sch_123 --yesThe two commands you’ll use most have shortcuts. reminix publish is
short for reminix scripts publish, and reminix run is short for
reminix scripts run. Each shortcut takes the same options and prints
the same output.
reminix --helplists the groups.reminix scripts --helplists the commands in a group.--helpafter any command lists its options.- A list prints one page, and its last line gives the
--cursorfor the next one. - A command that can’t be undone asks for
--yes.
Every command:
General
- Sign in through the browser, or store a personal access token with --token
reminix logout- Revoke the stored token and forget it
reminix whoami- Show who the token acts as and which workspaces it can use
reminix config- Show the settings in effect, with the token hidden
reminix init [command]- Make the script in this folder a Reminix script
reminix publish [dir.. . ] - Upload a folder's script and publish it. Short for reminix scripts publish
reminix upload [dir.. . ] - Upload a folder's script as a draft version. Short for reminix scripts upload
reminix run <slug>- Run a script and print its output. Use --number to test a draft. Short for reminix scripts run
reminix api <method> <path>- Call any API endpoint directly, in the selected workspace
Scripts
reminix scripts publish [dir.. . ] - Upload a folder's script and publish it, so runs use that version. Shortcut: reminix publish
reminix scripts upload [dir.. . ] - Upload a folder's script as a draft version, to test before publishing (shortcut: reminix upload)
reminix scripts run <slug>- Run a script and print its output. Use --number to test a draft. Shortcut: reminix run
reminix scripts archive <slug>- Archive a script
reminix scripts get <slug>- Get a script
reminix scripts list- List scripts
reminix scripts restore <slug>- Restore an archived script
reminix scripts update <slug>- Change a script
Runs
reminix runs cancel <run-id>- Cancel a run
reminix runs get <run-id>- Get a run
reminix runs list- List runs
reminix runs log <run-id>- Get a run's log
Files
reminix files download <file-id>- Download a file that a run received or saved
reminix files get <file-id>- Get a file
reminix files list- List files
reminix files upload <path>- Upload a file to give a run, and print its id
Schedules
reminix schedules create <slug>- Schedule a script
reminix schedules delete <slug> <schedule-id>- Delete a schedule
reminix schedules list <slug>- List a script's schedules
reminix schedules update <slug> <schedule-id>- Change a schedule
Triggers
reminix triggers calls <slug> <trigger-id>- List a webhook trigger's calls
reminix triggers create <slug>- Run a script when something happens
reminix triggers delete <slug> <trigger-id>- Delete a trigger
reminix triggers list <slug>- List a script's triggers
reminix triggers rotate-secret <slug> <trigger-id>- Rotate a webhook trigger's secret
reminix triggers update <slug> <trigger-id>- Change a trigger
Secrets
reminix secrets delete <name>- Delete a secret
reminix secrets list- List secrets
reminix secrets set <name>- Save a secret's value, read from stdin
Environments
reminix environments create- Add an environment
reminix environments delete <environment>- Delete an environment
reminix environments get <environment>- Get an environment
reminix environments list- List environments
reminix environments update <environment>- Change an environment
Script versions
reminix script-versions list <slug>- List a script's versions
Script settings
reminix script-settings get- Get the workspace's script settings
reminix script-settings update- Change the workspace's script settings
Secret values
reminix secret-values delete <name> <environment>- Remove a secret's value from an environment
Environment
reminix environment list- Show the environment commands act in
reminix environment use <name>- Make <name> the default environment for commands
reminix environment unset- Forget the default environment and go back to the product's default
Workspace and team
reminix workspace list- List the workspaces the token can act in
reminix workspace use <slug>- Make <slug> the default workspace for workspace commands
reminix workspace approval-actions list- List the actions you can ask approval for
reminix workspace approval-requests create- Ask a person to approve an action
reminix workspace approval-requests get <request-id>- Check an approval request
reminix workspace approval-requests redeem <request-id>- Collect an approved secret once, into an env file (never printed)
reminix workspace audit-events list- List workspace audit events
reminix workspace event-types list- List event types
reminix workspace get- Get the current workspace
reminix workspace invitations list- List pending invitations
reminix workspace members list- List workspace members
reminix workspace teams list- List teams
reminix workspace usage- Show your plan's usage this period
reminix workspace webhook-deliveries list <endpoint-id>- List an endpoint's deliveries
reminix workspace webhook-deliveries redeliver <endpoint-id> <delivery-id>- Redeliver an event
reminix workspace webhook-endpoints create- Add a webhook endpoint
reminix workspace webhook-endpoints delete <endpoint-id>- Remove a webhook endpoint
reminix workspace webhook-endpoints enable <endpoint-id>- Re-enable a webhook endpoint
reminix workspace webhook-endpoints get <endpoint-id>- Get a webhook endpoint
reminix workspace webhook-endpoints list- List webhook endpoints
reminix workspace webhook-endpoints test <endpoint-id>- Send a test event
reminix workspace webhook-endpoints update <endpoint-id>- Update a webhook endpoint
Personal access tokens
reminix user me- Get the current user
reminix user revoke-token- Revoke the token making this request
Scripts and agents
Section titled “Scripts and agents”Add --json to any command, and it prints exactly the JSON the API
returns to stdout. Errors then go to stderr as JSON, in the API’s
error envelope plus the HTTP status:
reminix scripts list --json | jq '.items[].slug'{ "error": { "code": "forbidden", "message": "…", "status": 403, "requestId": "…" }}The exit code is 0 on success and 1 on any failure, whether the API
refused the call or a flag was missing.
The API underneath
Section titled “The API underneath”Every command calls the same public API your code uses, signed in with your personal access token.
- A command that calls one API operation links to it in the list above. Under Endpoints, each operation shows its command next to the same call in TypeScript, Python and curl.
- Ids in an operation’s path become the command’s arguments, and its
other inputs become flags.
--data '{…}'sends a whole JSON body. - Every write sends an idempotency key. If an
attempt fails, the CLI retries it with the same key. To run a command
again without repeating its writes, pass the same
--idempotency-key <key>both times. reminix api <method> <path>calls any endpoint directly.