Command Line Interface

The simplest usage of the command line interface is just to run

roboherd run

Info

The watch and register commands require you to install roboherd[dev].

roboherd

Configuration is usually loaded from the config_file. These options can be overwritten by passing as a command line argument.

Usage:

roboherd [OPTIONS] COMMAND [ARGS]...

Options:

  --connection_string TEXT  Connection string to the websocket mqtt broker
  --base_url TEXT           Base url to create cows with
  --config_file TEXT        Configuration file
  --version                 display version then exit
  --help                    Show this message and exit.

roboherd check

Checks that the connection is configured correctly

Usage:

roboherd check [OPTIONS]

Options:

  --fail  Fail if actors do not exist
  --help  Show this message and exit.

roboherd register

Registers a new account on dev.bovine.social. All three options are required. If not provided, you will be prompted for them.

Usage:

roboherd register [OPTIONS]

Options:

  --name TEXT       Name for the account to be created
  --password TEXT   Password for the account to be created
  --fediverse TEXT  Fediverse handle
  --help            Show this message and exit.

roboherd run

Runs the roboherd by connecting to the server.

Usage:

roboherd run [OPTIONS]

Options:

  --help  Show this message and exit.

roboherd watch

Watches the file the module is in for changes and then restarts roboherd.

Note: Options for roboherd are currently ignored (FIXME).

Usage:

roboherd watch [OPTIONS]

Options:

  --help  Show this message and exit.