Authentication

Authenticating the Kubiya CLI with the Kubiya Platform.

Authentication

Before using the CLI to interact with the Kubiya Agentic Platform, you need to authenticate. The CLI uses API keys for authentication.

Authentication Methods

Set environment variable

# For temporary use in current terminal session
export KUBIYA_API_KEY=YOUR_API_KEY
 
# For permanent use (add to your shell profile)
echo 'export KUBIYA_API_KEY=YOUR_API_KEY' >> ~/.bashrc  # or ~/.zshrc

Verify auth works with the variable

kubiya version

Be careful not to expose your API key in scripts or logs.

Security Best Practices

Store API keys securely using environment variables or secure secret managers
Use scoped API keys with the minimal permissions needed for your use case
Regularly rotate API keys, especially for shared or automated systems
Avoid storing API keys in code repositories or unencrypted files

Troubleshooting

If you encounter authentication issues:

Verify your API key is valid and has not expired
Check that you're connecting to the correct Kubiya instance URL
Ensure network connectivity to the Kubiya API endpoint
Check for any firewalls or proxy settings that might block connections
Run kubiya --debug version for detailed diagnostic information

CLI Reference

Command-line interface for the Kubiya Agentic Platform.

Configuration

Configuring the Kubiya CLI using environment variables.