Kubiya CLI Command Reference
This document provides a comprehensive reference for all Kubiya CLI commands, their subcommands, flags, and usage examples.
Global Flags
These flags can be used with any command:
--help
, -h
Show help for a command
--version
, -v
Show CLI version information
--debug
Enable debug output for troubleshooting
--output
, -o
Set output format (text, json)
Core Commands
kubiya
kubiya
The root command for Kubiya CLI.
Usage:
Example:
kubiya browse
kubiya browse
Browse and execute tools interactively.
Usage:
Aliases:
b
kubiya chat
kubiya chat
Chat with your AI teammates.
Usage:
Flags:
--interactive
, -i
Start an interactive chat session
--teammate
, -t
Specify the teammate to chat with
--session
, -s
Specify a session ID to continue a conversation
--clear-session
Clear the current session context
--list-sessions
List active chat sessions
--files
, -f
Include files as context for the chat
--stream
Stream the response as it's generated
Examples:
kubiya config
kubiya config
Manage Kubiya CLI configuration.
Subcommands:
set
- Set a configuration valueview
- View current configurationreset
- Reset configuration to defaults
Examples:
kubiya update
kubiya update
Update the Kubiya CLI to the latest version.
Usage:
Source Management Commands
kubiya source
kubiya source
Manage your automation sources.
Aliases:
sources
Subcommands:
list
- List all sourcesadd
- Add a new sourcedescribe
- Get detailed information about a sourcedelete
- Delete a sourcesync
- Sync a source with latest changesupdate
- Update source configurationdebug
- Debug source issues
Examples:
kubiya source list
kubiya source list
List all sources.
Flags:
--output
, -o
Output format (text, json)
--full
Show full source details
kubiya source add
kubiya source add
Add a new source.
Flags:
--name
, -n
Source name
--url
Git repository URL
--path
Local path to source
--branch
, -b
Git branch
--auth-token
Authentication token for private repositories
kubiya source sync
kubiya source sync
Sync a source with latest changes.
Flags:
--all
Sync all sources
--mode
Sync mode (interactive, non-interactive, ci)
--branch
Git branch to sync
Tool Management Commands
kubiya tool
kubiya tool
Manage and execute tools.
Aliases:
tools
Subcommands:
list
- List all toolssearch
- Search for toolsdescribe
- Get detailed information about a toolexecute
- Execute a tool
Examples:
kubiya tool list
kubiya tool list
List all tools.
Flags:
--output
, -o
Output format (text, json)
--source
, -s
Filter by source ID
kubiya tool search
kubiya tool search
Search for tools.
Flags:
--output
, -o
Output format (text, json)
kubiya tool execute
kubiya tool execute
Execute a tool.
Flags:
--args
, -a
JSON string of arguments for the tool
--interactive
, -i
Execute in interactive mode
kubiya generate
kubiya generate
Generate Kubiya resources from templates.
Subcommands:
tool
- Generate a tool template
Flags:
--name
, -n
Name for the generated resource
--output
, -o
Output directory
Knowledge Management Commands
kubiya knowledge
kubiya knowledge
Manage knowledge base items.
Aliases:
k
Subcommands:
list
- List all knowledge itemsget
- Get a specific knowledge itemcreate
- Create a new knowledge itemupdate
- Update a knowledge itemdelete
- Delete a knowledge itemedit
- Edit a knowledge item in your default editor
Examples:
kubiya knowledge create
kubiya knowledge create
Create a new knowledge item.
Flags:
--title
, -t
Title of the knowledge item
--content
, -c
Content file path or string
--tags
Tags for categorization
Runner Management Commands
kubiya runner
kubiya runner
Manage automation runners.
Subcommands:
list
- List all runnersdescribe
- Get detailed information about a runnermanifest
- Get a runner manifest
Examples:
Secret Management Commands
kubiya secret
kubiya secret
Manage secrets for your tools and integrations.
Aliases:
secrets
Subcommands:
list
- List all secretscreate
- Create a new secretupdate
- Update a secretdelete
- Delete a secret
Examples:
Teammate Management Commands
kubiya teammate
kubiya teammate
Manage your AI teammates.
Aliases:
teammates
Subcommands:
list
- List all teammatesdescribe
- Get detailed information about a teammatecreate
- Create a new teammateupdate
- Update a teammatedelete
- Delete a teammate
Examples:
Webhook Management Commands
kubiya webhook
kubiya webhook
Manage webhooks.
Aliases:
webhooks
Subcommands:
list
- List all webhooksdescribe
- Get detailed information about a webhookcreate
- Create a new webhookupdate
- Update a webhookdelete
- Delete a webhookexecute
- Execute a webhook
Examples:
Integration Management Commands
kubiya integration
kubiya integration
Manage integrations with external services.
Subcommands:
list
- List all integrationssetup
- Set up a new integrationdescribe
- Get detailed information about an integration
Examples:
Advanced Usage Commands
kubiya version
kubiya version
Display the current version of the Kubiya CLI.
Usage:
Exit Codes
Kubiya CLI uses the following exit codes:
0
Success
1
General error
2
Command line parsing error
3
API error
4
Authentication error
5
Network error
Environment Variables
You can configure the Kubiya CLI using these environment variables:
KUBIYA_API_KEY
API key for authentication
KUBIYA_API_URL
Custom API endpoint URL
KUBIYA_DEBUG
Enable debug mode (true/false)
KUBIYA_OUTPUT_FORMAT
Default output format (text/json)
For more detailed information on each command, use the --help
flag with any command or subcommand.
Was this helpful?