Quickstart

By the end of this page you’ll have a script that greets someone by name, published in your workspace, and you’ll have run it from the command line and the app.

Want to see Reminix work first? On the empty Scripts page, owners and admins can click Add example scripts: four small scripts, published and ready to run from the app. Remove examples takes them away again.

1. Create a workspace

Sign up, verify your email and create a workspace. Scripts, secrets and runs all belong to a workspace.

2. Install the command line and sign in

npm install -g @reminix/cli
reminix login

Your browser opens: choose your workspace, allow the command line to manage scripts and runs, and click Allow.

3. Write the script

Any command you can run works. Here it’s a few lines of Python, saved as hello.py in a new folder called hello:

hello/hello.py

import json, sys

name = sys.argv[1]
print(f"greeting {name}", file=sys.stderr)
print(json.dumps({"message": f"Hello, {name}!"}))

What the script prints to standard output is its result, and what it prints to standard error is its log. Now tell Reminix how to run it, with {name} where the input goes:

cd hello && reminix init "python hello.py {name}"

This writes a README.md and a reminix.json with the command and an input called name. Give the script a name and the input a title:

{
  "slug": "hello",
  "name": "Say hello",
  "command": "python hello.py {name}",
  "inputSchema": {
    "type": "object",
    "required": ["name"],
    "properties": { "name": { "type": "string", "title": "Name" } }
  }
}

4. Publish it

reminix scripts publish --publish

The first publish creates the script and makes version 1 live. Without --publish, it would upload a draft that nobody else can run yet.

5. Run it

From the command line:

reminix scripts run hello --input '{"name":"Ada"}' --log

{ "message": "Hello, Ada!" }

In the app, open Scripts → Say hello: the input you described is a form with a Run button, and the run you just made is in its history. Through the API it’s POST /v1/scripts/hello/runs, and to an AI agent connected over MCP it’s a tool called hello.

Next, read Scripts to call APIs with your secrets, or pick a guide close to what you’re building.