agent runs the ChatBotKit CLI agent inside a GitHub Actions job.
This action executes cbk agent via an isolated npm exec invocation of @chatbotkit/cli in the target working directory.
prompt- Required task prompt passed tocbk agent --prompttools- Optional tool list passed tocbk agent --toolsbot- Optional bot id passed tocbk agent --botmodel- Optional model name passed tocbk agent --modeldataset- Optional dataset id passed tocbk agent --datasetskillset- Optional skillset id passed tocbk agent --skillsetcli-version- Optional CLI version to execute, defaults tolatestnode-version- Optional Node.js version, defaults to20working-directory- Optional working directory, defaults to.
The optional CLI-facing inputs are applied in this order: tools, bot, model, dataset, skillset.
Set the secrets and environment variables required by your ChatBotKit CLI configuration. In most cases that means exporting CHATBOTKIT_API_KEY from repository or organization secrets.
jobs:
agent:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: chatbotkit/github-actions/agent@v0
with:
tools: read,write,edit,find,exec
bot: bot_123
model: gpt-5
dataset: dataset_123
skillset: skillset_123
prompt: >-
Read the repository and propose a small documentation improvement.
cli-version: 1.34.0
working-directory: .
env:
CHATBOTKIT_API_KEY: ${{ secrets.CHATBOTKIT_API_KEY }}- Prefer pinned
cli-versionvalues for reproducible workflows. - The CLI is executed without a global install, which avoids leaving shared state on self-hosted runners.
- The action runs with the permissions, checked-out files, and runner access provided by the calling workflow.
- For centralized orchestration across many repositories, pair this action with a reusable workflow in the same repository.