Skip to main content
Channel commands manage plugin processes that connect external systems (for example, Telegram or WhatsApp) to your Hiro League server. All channel configuration is workspace-scoped. Use --workspace to target a specific workspace.

​
List channels

hirocli channel list --workspace <name>
Lists configured channel plugins and shows:
  • whether each channel is enabled
  • launch command
  • configured key names

​
Install a channel plugin

hirocli channel install <name>
Installs a plugin package using uv tool install.

​
Options

OptionDescription
--package, -pOverride package name (default: hiro-channel-<name>).
--editable, -eInstall in editable mode.

​
Examples

# Install default package
hirocli channel install telegram

# Install custom package name
hirocli channel install telegram --package my-telegram-plugin

​
Setup a channel

hirocli channel setup <name> --workspace <name>
Creates or updates a channel configuration entry. During setup, the CLI prompts for the plugin command. By default it uses hiro-channel-<name>.

​
Options

OptionDescription
--workspace, -WWorkspace to configure.
--command, -cDefault command shown in the setup prompt.
--enable/--no-enableEnable or disable channel after setup.

​
Examples

# Setup telegram in home workspace
hirocli channel setup telegram --workspace home

# Setup with explicit command
hirocli channel setup telegram --workspace home --command "hiro-channel-telegram"
The devices channel is mandatory and is always forced to enabled mode.

​
Enable a channel

hirocli channel enable <name> --workspace <name>
Marks a configured channel as enabled.

​
Disable a channel

hirocli channel disable <name> --workspace <name>
Marks a configured channel as disabled.
You cannot disable the mandatory devices channel.

​
Remove a channel config

hirocli channel remove <name> --workspace <name>
Removes channel configuration from the workspace.

​
Options

OptionDescription
--workspace, -WWorkspace containing the config.
--yes, -ySkip confirmation prompt.
You cannot remove the mandatory devices channel config.

​
Check connected channel status

hirocli channel status --workspace <name>
Queries the running server HTTP API and lists channel plugins currently connected at runtime. If the server is not running, the command returns a connection error with guidance to check server status.

​
Typical workflow

hirocli channel install telegram
hirocli channel setup telegram --workspace home
hirocli channel list --workspace home
hirocli stop --workspace home
hirocli start --workspace home
hirocli channel status --workspace home