Skip to content

Config file

A single YAML file that describes everything: your bot token, who may use the bot, and the menu of buttons. You pass it with --config to the commands that read it: run, validate, fmt, and list-functions. Other commands, such as version and completion, do not take a config file.

A working config with one button

config.yaml
telegram:
  bot_token: "YOUR_BOT_TOKEN"
  allowed_users:
    - "123456789"

menu:
  - name: Uptime
    type: button
    function: command
    command: "uptime"
  • Configuration — every field, default, and validation rule
  • Menu — the button and category tree
  • CLI — pass the file with --config
  • Run in CLI — create your first config