Command line · RoachNet Docs

Run it

The helper isn't on your PATH. Call it by its full path, or make a shell alias:

Terminal

alias roachnet-runtime=~/RoachNet/app/RoachNet.app/Contents/Helpers/roachnet-runtime
roachnet-runtime --version

Commands

Command	What it does
`roachnet-runtime`	Starts the local runtime, reading the environment variables
`--stop`	Stops a running runtime for this storage folder
`--setup`	Serves the setup service on loopback, as RoachNet Setup does
`--install`	Installs headlessly, with the same staged steps as RoachNet Setup
`--provision-alias`	Points the `RoachNet` hostname at loopback in `/etc/hosts`
`--version`	Prints the version
`--build-info`	Prints the version and the source commit the build was stamped with, as JSON
`--help`	Lists the commands

Install options

Option	What it does
`--install-path PATH`	Where to install. The default is `~/RoachNet`.
`--storage-path PATH`	Where data lives. The default is `<install path>/storage`.
`--no-roachclaw`	Installs without RoachClaw: no starter model, and a smaller space check
`--launch`	Opens RoachNet when the install finishes
`--profile NAME`	Records an install profile in the installer settings, such as `homebrew-cask`
`--no-companion`	Leaves the companion bridge off until you turn it on in the app

Terminal

roachnet-runtime --install --install-path ~/RoachNet --no-roachclaw

--provision-alias takes --hosts-file PATH to edit another file. Editing /etc/hosts needs administrator rights, so --print-command prints the command instead of running it, for you to run yourself.

Exit codes

Code	Meaning
`0`	Success. `--install` also prints where it installed RoachNet.
`1`	Failure. The reason is printed on standard error, for example `RoachNet install failed: …`