CLI reference

CLI reference

Every install ships the cronable command-line tool alongside the daemon — the same binary that runs the service also drives it from a terminal. Run cronable help any time for the built-in summary.

cronable <command> [options]

On a system install the CLI lives inside /opt/cronable (on your PATH as cronable); on a per-user install it’s in ~/.local/bin. If cronable isn’t found, use the full path or re-run the installer.

Everyday

cronable status

Show whether the daemon is running and your license state. Add --json for a machine-readable form (useful in scripts / monitoring).

cronable status
cronable status --json

cronable doctor

A preflight health check — daemon reachability, license validity, jobs loading, and git-sync state. Run it first whenever something looks off.

cronable update

Check the release channel and, if a newer signed build is available, apply it (verify → atomic swap → restart). Updates also apply automatically in the background; this forces a check now.

cronable update

cronable run <jobId>

Trigger a job immediately, outside its schedule.

OptionMeaning
--waitBlock until the run finishes; the exit code reflects the outcome (non-zero = failed).
--timeout <seconds>Max seconds to wait with --wait (default 300).
cronable run daily-backup
cronable run daily-backup --wait --timeout 600

cronable logs [daemon|web]

Stream live logs for the daemon (default) or the dashboard (web). --follow/-f keeps streaming (on by default).

cronable logs            # daemon logs
cronable logs web        # dashboard logs

cronable start / stop / restart

Start, stop, or restart Cronable (the daemon and the dashboard) in the background. Use restart after changing settings or adding an extension.

Setup

cronable login

Log in with your account email + password to fetch your license.

OptionMeaning
--email <email>Skip the email prompt.
--password <pw>Skip the password prompt (avoid on shared machines — it lands in your shell history).

cronable install

Set Cronable up on this machine and open the dashboard. (The Quickstart one-liner runs this for you.)

OptionMeaning
--jobs-dir <path>Where your jobs live (default ~/cronable-jobs).
--port <n>Daemon port (default 8787).
--web-port <n>Dashboard port (default 8788).
--daemon-entry <p>Path to the daemon runner (run.mjs) — for dev/custom layouts.
--web-entry <p>Path to the web shell (server.js) — enables the local dashboard service.

Jobs

cronable export

Export jobs as a portable bundle (to move them to another machine, or to version them).

OptionMeaning
--group <g>Only this job group.
--out <file>Write to a file (default: stdout).
cronable export --out my-jobs.json
cronable export --group ops --out ops-jobs.json

cronable import <file>

Import a job bundle — create-only (it never overwrites an existing job). Pass - or omit the file to read from stdin.

OptionMeaning
--dry-runPreview what would be created, change nothing.
cronable import my-jobs.json --dry-run
cronable import my-jobs.json

Extensions

cronable extensions <cmd>

Author your own job types. Subcommands: where (print the extensions dir), list, scaffold <id>, build, enable-unsigned. See Extensions for the full authoring guide.

cronable extensions scaffold my-connector
cronable extensions build

Removing Cronable? See Uninstalling. Updates and the release channel are covered in Updates.