Skip to main content
The Streamkap CLI lets you manage your CDC infrastructure from the terminal. It covers the full Streamkap API — pipelines, sources, destinations, transforms, topics, and more. The CLI is designed to work well in both interactive and agentic workflows. Output defaults to human-readable text in a terminal and switches to JSON when piped to another process or AI agent.

​
Prerequisites

  • Node.js 20+
  • An API token (Client ID and Client Secret) — see API Tokens for how to create one

​
Installation

npm install -g @streamkap/tools

​
Authentication

The CLI supports three authentication methods:
Recommended for CI/CD and scripts:
export STREAMKAP_CLIENT_ID="your-client-id"
export STREAMKAP_CLIENT_SECRET="your-client-secret"

​
Usage

streamkap --help                          # List all commands
streamkap pipelines list                  # List pipelines
streamkap pipelines get <id>             # Get pipeline details
streamkap sources list                    # List sources
streamkap sources metrics <id>           # Source metrics
streamkap destinations list              # List destinations
streamkap dashboard stats                # Organisation overview
streamkap doctor                         # Validate setup & connectivity

​
Output Formats

By default, output is human-readable text in a terminal and JSON when piped. Override with: 
streamkap pipelines list --json          # Force JSON output
streamkap pipelines list --format text   # Force text output

​
Destructive Commands

Commands that modify or delete resources (delete, stop, reset) require confirmation in interactive mode. Use --yes to skip confirmation or --dry-run to preview the action: 
streamkap sources stop <id> --dry-run    # Preview what would happen
streamkap sources stop <id> --yes        # Skip confirmation
When output is piped (non-TTY), destructive commands execute without confirmation to support scripting and agentic workflows.

​
Commands

GroupDescription
pipelinesCreate, update, delete, monitor metrics and logs, bulk operations
sourcesManage CDC connectors, deploy, pause, resume, stop, restart, snapshots
destinationsManage sinks, deploy, pause, resume, stop, restart
transformsManage stream processors, deploy to preview/production, unit tests, clone
topicsList, inspect, create Kafka topics, read sample messages
tagsOrganise resources with tags
schema-registryBrowse subjects and schemas
consumer-groupsInspect lag, reset offsets
kafka-accessManage direct Kafka cluster users
dashboardOrganisation statistics, log search and aggregation
alertsManage subscribers and notification preferences
billingUsage metrics and export
adminList and switch services
authLogin, logout, status, token management
doctorValidate setup, credentials, and API connectivity
completionsGenerate shell completion scripts

​
Global Options

FlagDescription
-j, --jsonForce JSON output
-f, --format <fmt>Output format: json, text, or auto (default: auto)
-p, --profile <name>Named credential profile
--api-url <url>Override API URL
--client-id <id>Override client ID
--client-secret <secret>Override client secret
-v, --verboseShow request method, path, and timing on stderr
-q, --quietSuppress all non-data output
-y, --yesSkip confirmation for destructive commands
--no-colorDisable ANSI colors
-V, --versionShow CLI version

​
Shell Completions

Generate shell completions for your shell: 
streamkap completions bash >> ~/.bashrc
streamkap completions zsh >> ~/.zshrc
streamkap completions fish > ~/.config/fish/completions/streamkap.fish