steadlake

The command-line interface for Steadlake. Run Steadlake tasks locally and inspect their runs from your terminal.

steadlake is the CLI package. Application code uses @steadlake/task to define and trigger tasks.

Installation

Install the CLI globally with npm:

npm install --global steadlake

This installs two equivalent commands:

steadlake --help
sl --help

You can also run it without a global installation:

npx steadlake task dev

Local task development

Start the local task orchestrator:

steadlake task dev

The server listens on http://127.0.0.1:8288 by default and starts an embedded PGlite database and local DEW workers. Task code continues to run inside your application and is dispatched over HTTP; the CLI does not import or execute your task source.

Run your application with local development enabled in another terminal:

STEADLAKE_DEV=1 npm run dev

Development options

--port <number>     API port (default: 8288)
--host <address>    Bind address (default: 127.0.0.1)
--data-dir <path>   Persist local PGlite data at this path

For example:

steadlake task dev --port 9000 --data-dir .steadlake

Stop the runtime with Ctrl+C.

Inspect local runs

List recent runs:

steadlake task runs list
# Short alias:
steadlake task runs ls

Show one run and its event timeline:

steadlake task runs get <run-id>

Run inspection connects to http://127.0.0.1:8288 by default. Point it at another local server with --url:

steadlake task runs list --url http://127.0.0.1:9000
steadlake task runs get <run-id> --url http://127.0.0.1:9000

Environment variables

| Variable | Purpose | | --- | --- | | STEADLAKE_DEV_PORT | Changes the default local server port. | | STEADLAKE_DEV_URL | Changes the default URL used by task runs commands. |

Explicit command options take precedence over environment defaults.

Commands

steadlake task dev
steadlake task runs list
steadlake task runs ls
steadlake task runs get <run-id>
steadlake --help
steadlake --version

Every command can also be invoked through the sl alias.