Skip to content

CLI Usage

Commands

openslaq login

Authenticate with your OpenSlaq workspace.

Terminal window
openslaq login [--api-url <url>]
FlagDescription
--api-urlAPI URL for self-hosted instances (default: https://api.openslaq.com)

openslaq bot

Manage bots in your workspace.

Terminal window
# List all bots
openslaq bot list
# Create a new bot
openslaq bot create <name> [--description <desc>]
# Delete a bot
openslaq bot delete <bot-id>
# Rotate a bot's token
openslaq bot rotate-token <bot-id>

openslaq api-key

Manage API keys.

Terminal window
# List API keys
openslaq api-key list
# Create a new API key
openslaq api-key create <name> [--scopes <scope1,scope2>]
# Revoke an API key
openslaq api-key revoke <key-id>

openslaq workspace

View workspace information.

Terminal window
# Show current workspace info
openslaq workspace info
# List workspace members
openslaq workspace members

openslaq channel

Manage channels.

Terminal window
# List channels
openslaq channel list
# Send a message to a channel
openslaq channel send <channel-id> "Hello from the CLI!"

Global flags

FlagDescription
--help, -hShow help for a command
--version, -vShow CLI version
--api-urlOverride the API URL
--tokenUse a specific API token (instead of stored credentials)
--jsonOutput in JSON format