devtools
CircleCI CLI for Shell Scripts
Use the CircleCI CLI for shell scripts with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 6 read 1 write Bearer token auth
CircleCI CLI for Shell Scripts
Call integration functions from shell scripts with stable JSON input and output.
Use shell scripts for small local automations that need one or more integration calls. The CircleCI CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# CircleCI CLI for Shell Scripts
kosmokrator integrations:configure circleci --set access_token="$CIRCLECI_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmo integrations:call circleci.circleci_list_pipelines '{"orgSlug":"example_orgSlug","branch":"example_branch","limit":1,"page_token":"example_page_token"}' --json Discovery Before Execution
Agents and scripts can inspect CircleCI docs and schemas before choosing a function.
kosmo integrations:docs circleci --json
kosmo integrations:docs circleci.circleci_list_pipelines --json
kosmo integrations:schema circleci.circleci_list_pipelines --json
kosmo integrations:search "CircleCI" --json
kosmo integrations:list --json Useful CircleCI CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
circleci.circleci_list_pipelines | Read | orgSlug, branch, limit, page_token | List recent CI/CD pipelines in CircleCI. Filter by organization slug and branch. Returns pipeline IDs, status, trigger information, and revision details. |
circleci.circleci_get_pipeline | Read | id | Get detailed information about a specific CircleCI pipeline, including its status, configuration, trigger source, and commit details. |
circleci.circleci_list_workflows | Read | pipeline_id | List all workflows for a specific CircleCI pipeline. Shows workflow names, statuses (running, success, failed, etc.), and timing information. |
circleci.circleci_get_workflow | Read | id | Get detailed information about a specific CircleCI workflow, including its status, timing, duration, and associated project. |
circleci.circleci_list_projects | Read | orgSlug, limit | List all projects in a CircleCI organization. Returns project slugs, repository URLs, and VCS provider information. |
circleci.circleci_trigger_pipeline | Write | orgSlug, projectSlug, branch, parameters | Trigger a new CI/CD pipeline on a CircleCI project. Specify the organization, project, branch, and optional pipeline parameters. |
circleci.circleci_get_current_user | Read | none | Get the current authenticated CircleCI user profile. Returns login, name, and account details. Useful for verifying API token validity. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.