Command Line Interface

Runhouse provides CLI commands for logging in/out, and for basic interaction with the cluster.

The commands can be run like follows:

runhouse.main.login(token: str | None = <typer.models.ArgumentInfo 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.notebook(cluster_name: str, up: bool = <typer.models.OptionInfo object>)[source]

Open a Jupyter notebook on a cluster.

runhouse.main.restart(name: str = <typer.models.OptionInfo 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>, use_local_telemetry: bool = <typer.models.OptionInfo object>)[source]

Restart the HTTP server on the cluster.

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

SSH into a cluster created elsewhere (so ssh cluster doesn’t work out of the box) or not yet up.

runhouse.main.start(restart_ray: bool = <typer.models.OptionInfo object>, screen: bool = <typer.models.OptionInfo object>, nohup: 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>, use_caddy: bool = <typer.models.OptionInfo object>, domain: str = <typer.models.OptionInfo object>, certs_address: str | None = <typer.models.OptionInfo object>, use_local_telemetry: bool = <typer.models.OptionInfo object>)[source]

Start the HTTP or HTTPS server on the cluster.

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

Get the config info about your runhouse cluster(s), as well as the environments setup of the cluster(s)