Skip to content

CLI

runy [OPTIONS] <COMMAND>
option
--port <PORT> the daemon’s API port, default 4122
--workspace <NAME> on ns and signal: the workspace, instead of the one enclosing the cwd
--json machine-readable output
--verbose debug logging
-n, --no-daemon run the daemon inside this process instead of connecting to one
--daemonize <true|false> whether a daemon this command starts detaches, default true

Every command connects to the daemon and starts one when none runs; a daemon of another build is upgraded in place first.

Terminal window
runy ns # list the workspace's namespaces
runy ns up [NAMES]... # activate; no names: the namespace enclosing the cwd
runy ns down [NAMES]... # deactivate, which stops their resources

The list has each namespace’s name, whether it is active, its resource count, its folder and its diagnostics count, followed by the diagnostics themselves and the proxy’s state when its bind failed. See Workspaces and namespaces.

Terminal window
runy ps

Every resource of every active namespace: workspace, namespace, id, condition and a one-line status (running healthy, stopped (exit 0), 3010 → http://web.localhost, a folder’s path).

Terminal window
runy signal <namespace>/<kind>/<name> <SIGNAL>
runy signal workspace restart

Sends a signal to a resource: a process takes restart and stop. workspace restart re-reads the resource files and the environment.

Terminal window
runy daemon start [--addr <ADDR>] [--proxy-addr <ADDR>] [--stdout <FILE>] [--stderr <FILE>] [--pidfile <FILE>] [--daemonize <true|false>]
runy daemon stop
runy daemon restart

--addr is the API (default 127.0.0.1:4122), --proxy-addr the proxy (default 0.0.0.0:80). start --adopt <record> is what an upgrading daemon passes to its successor; it is not for hand use.

Terminal window
runy info folder

Prints the per-user cache folder.