Gateway Channel Lifecycle

Add, update, disable, or remove one gateway channel non-interactively — CLI and Python, no wizard, no hand-editing.

Edit one channel in gateway.yaml / bot.yaml with a single command — other channels and settings stay untouched, and invalid edits are never written.

Quick Start

1. Let an agent manage channels

   from praisonaiagents import Agent
   from praisonai_bot import edit_gateway_channel
   
   def disable_channel(name: str) -> str:
       """Stop serving one gateway channel but keep its config."""
       edit_gateway_channel("gateway.yaml", name, {"enabled": False})
       return f"Disabled {name}"
   
   agent = Agent(
       name="gateway-ops",
       instructions="Manage my chat channels — pause them when asked.",
       tools=[disable_channel],
   )
   agent.start("Pause the Slack channel.")

2. Or run the CLI directly

   # Add a channel (token defaults to the platform's ${VAR} reference)
   praisonai gateway channels add telegram
   
   # Add a channel with extra fields in one shot
   praisonai gateway channels add discord --set group_policy=mention_only
   
   # Rotate a token and change a policy
   praisonai gateway channels update telegram --token '${NEW_TELEGRAM_TOKEN}' --set group_policy=mention_only
   
   # Stop serving a channel but keep its config
   praisonai gateway channels disable slack
   
   # Delete the channel block entirely
   praisonai gateway channels remove slack

3. Or call the Python helper

   from praisonai_bot import edit_gateway_channel
   
   edit_gateway_channel("gateway.yaml", "discord", {"token": "${DISCORD_BOT_TOKEN}"})   # add
   edit_gateway_channel("gateway.yaml", "telegram", {"group_policy": "mention_only"})   # update
   edit_gateway_channel("gateway.yaml", "telegram", {"enabled": False})                 # disable
   edit_gateway_channel("gateway.yaml", "slack", remove=True)                           # remove

How It Works

Every edit is a locked read-modify-write: read the file, merge the change into channels[name], validate the whole document, then atomically replace the file.

A failed validation leaves the file byte-for-byte unchanged, so a bad edit can never take a running gateway down on its next reload.

Choosing a Subcommand

Pick the subcommand by what should happen to the channel block.

CLI Reference

All four subcommands accept --config / -c; when omitted they use the parent gateway channels --config value, which falls back to gateway.yaml and the onboarded ~/.praisonai/bot.yaml (see Config Discovery).

praisonai gateway channels add support --platform discord --set group_policy=mention_only

from praisonai_bot import edit_gateway_channel

edit_gateway_channel(config_path, name, settings=None, *, remove=False) -> dict

praisonai gateway channels update telegram --token '${TELEGRAM_BOT_TOKEN_V2}'

from praisonai_bot import edit_gateway_channel

for tenant in ["acme", "globex"]:
    edit_gateway_channel(
        f"/etc/praisonai/{tenant}/bot.yaml",
        "discord",
        {"token": f"${{{tenant.upper()}_DISCORD_TOKEN}}"},
    )

praisonai gateway channels add discord