Command Line Interface

Runhouse provides CLI commands for the following use cases:

• logging in and out (runhouse login/logout)

• interacting with or retrieving information about clusters (runhouse cluster <cmd>)

• interacting with the Runhouse server (runhouse server <cmd>)

The commands can be run using either runhouse or the rh` alias

runhouse.main.cluster_down(cluster_name: str = <typer.models.ArgumentInfo object>, remove_configs: bool = <typer.models.OptionInfo object>, remove_all: bool = <typer.models.OptionInfo object>, force_deletion: bool = <typer.models.OptionInfo object>)[source]

Terminate cluster if it is not down. No-op if cluster is already down. This only applies to on-demand clusters, and has no effect on self-managed clusters.

Example

$ runhouse cluster down rh-basic-cpu

runhouse.main.cluster_keep_warm(cluster_name: str = <typer.models.ArgumentInfo object>, mins: int | None = <typer.models.OptionInfo object>)[source]

Keep the cluster warm for given number of minutes after inactivity.

Example

$ runhouse cluster keep-warm rh-basic-cpu

runhouse.main.cluster_list(show_all: bool = <typer.models.OptionInfo object>, since: str | None = <typer.models.OptionInfo object>, cluster_status: ~runhouse.resources.hardware.utils.ClusterStatus | None = <typer.models.OptionInfo object>, force: bool = <typer.models.OptionInfo object>)[source]

Load Runhouse clusters

Example

$ runhouse cluster list

$ runhouse cluster list --all

$ runhouse cluster list --status running

$ runhouse cluster list --since 15m

runhouse.main.cluster_logs(cluster_name: str = <typer.models.ArgumentInfo object>, since: ~runhouse.cli_utils.LogsSince | None = <typer.models.OptionInfo object>)[source]

Load the logs of the Runhouse server running on a cluster.

Example

$ runhouse cluster logs rh-basic-cpu

$ runhouse cluster logs rh-basic-cpu --since 60

runhouse.main.cluster_ssh(cluster_name: str)[source]

SSH into a remote cluster.

Example

$ runhouse cluster ssh rh-basic-cpu

runhouse.main.cluster_status(cluster_name: str = <typer.models.ArgumentInfo object>, send_to_den: bool = <typer.models.OptionInfo object>)[source]

Load the status of the cluster.

Example

$ runhouse cluster status rh-basic-cpu

runhouse.main.cluster_up(cluster_name: str = <typer.models.ArgumentInfo object>)[source]

Bring up the cluster if it is not up. No-op if cluster is already up. This only applies to on-demand clusters, and has no effect on self-managed clusters.

Note: To launch the cluster via Den, set launcher: den in your local ~/.rh/config.yaml.

Example

$ runhouse cluster up rh-basic-cpu

runhouse.main.login(token: str | None = <typer.models.ArgumentInfo object>, sync_secrets: bool | None = <typer.models.OptionInfo object>, yes: bool | None = <typer.models.OptionInfo object>)[source]

Login to Runhouse. Validates token provided, with options to upload or download stored secrets or config between local environment and Runhouse / Vault.

runhouse.main.logout()[source]

Logout of Runhouse. Provides options to delete locally configured secrets and local Runhouse configs

runhouse.main.server_restart(cluster_name: str = <typer.models.ArgumentInfo object>, restart_ray: bool = <typer.models.OptionInfo object>, screen: bool = <typer.models.OptionInfo object>, nohup: bool = <typer.models.OptionInfo object>, resync_rh: bool = <typer.models.OptionInfo object>, host: str | None = <typer.models.OptionInfo object>, port: str | None = <typer.models.OptionInfo object>, use_https: bool = <typer.models.OptionInfo object>, use_den_auth: bool = <typer.models.OptionInfo object>, ssl_keyfile: str | None = <typer.models.OptionInfo object>, ssl_certfile: str | None = <typer.models.OptionInfo object>, restart_proxy: bool = <typer.models.OptionInfo object>, use_caddy: bool = <typer.models.OptionInfo object>, domain: str = <typer.models.OptionInfo object>, certs_address: str | None = <typer.models.OptionInfo object>, api_server_url: str = <typer.models.OptionInfo object>, conda_env: str = <typer.models.OptionInfo object>, from_python: bool = <typer.models.OptionInfo object>)[source]

Restart the HTTP server on the cluster.

Example

$ runhouse server restart

$ runhouse server restart rh-cpu

runhouse.main.server_start(cluster_name: str | None = <typer.models.ArgumentInfo object>, restart_ray: bool = <typer.models.OptionInfo object>, screen: bool = <typer.models.OptionInfo object>, nohup: bool = <typer.models.OptionInfo object>, resync_rh: bool = <typer.models.OptionInfo object>, host: str | None = <typer.models.OptionInfo object>, port: str | None = <typer.models.OptionInfo object>, use_https: bool = <typer.models.OptionInfo object>, use_den_auth: bool = <typer.models.OptionInfo object>, ssl_keyfile: str | None = <typer.models.OptionInfo object>, ssl_certfile: str | None = <typer.models.OptionInfo object>, restart_proxy: bool = <typer.models.OptionInfo object>, use_caddy: bool = <typer.models.OptionInfo object>, domain: str = <typer.models.OptionInfo object>, certs_address: str | None = <typer.models.OptionInfo object>, api_server_url: str = <typer.models.OptionInfo object>, conda_env: str = <typer.models.OptionInfo object>, from_python: bool = <typer.models.OptionInfo object>)[source]

Start the HTTP server on the cluster.

Example

$ runhouse server start

$ runhouse server start rh-cpu

runhouse.main.server_status(cluster_name: str = <typer.models.ArgumentInfo object>)[source]

Check the HTTP server status on the cluster.

Example

$ runhouse server status

$ runhouse server status rh-cpu

runhouse.main.server_stop(cluster_name: str | None = <typer.models.ArgumentInfo object>, stop_ray: bool = <typer.models.OptionInfo object>, cleanup_actors: bool = <typer.models.OptionInfo object>)[source]

Stop the HTTP server on the cluster.

Example

$ runhouse server stop

$ runhouse server stop rh-cpu