Reference

The Bindplane CLI provides a comprehensive set of commands for managing agents, resources, configurations, users, organizations, and more. This reference covers all available commands and their usage.

Getting Started

Basic Usage

1bindplane [command] [flags]

Help

Get help for any command:

1bindplane <command> --help

Version Information

1bindplane version

Displays both server and client version details.

Core Commands

init / initialize

Initialize a Bindplane installation.

serve

Start the Bindplane server.

1bindplane serve [--force-console-color] [--skip-seed]

Flags:

• --force-console-color: Force colored output
• --skip-seed: Do not seed resource types on startup

Resource Management

get

Display resources and their details.

Syntax:

1bindplane get <resource-type> [id/name] [flags]

Available Resource Types:

• agents / agent - Agent instances
• agent-types / agent-type - Agent type definitions
• agent-versions / agent-version - Agent version definitions
• configurations / configuration / configs / config - Agent configurations
• sources / source - Data sources
• source-types / source-type - Source type definitions
• processors / processor - Data processors
• processor-types / processor-type - Processor type definitions
• destinations / destination - Data destinations
• destination-types / destination-type - Destination type definitions
• extensions / extension - Extensions
• extension-types / extension-type - Extension type definitions
• connectors / connector - Connectors
• connector-types / connector-type - Connector type definitions
• recommendation-types / recommendation-type - Recommendation types
• available-components / available-component - Available components
• rollouts / rollout - Configuration rollouts
• organizations / organization - Organizations
• accounts / account - Projects/accounts
• users / user - Users
• audit-events / audit-event - Audit events
• organization-accounts / organization-account - Organization accounts
• organization-users / organization-user - Organization users
• recordings / recording - Recordings
• fleets / fleet - Agent fleets
• resources - All resources

Common Flags:

• --history: Show resource history (where supported)
• --export: Export resource in importable format
• --selector: Filter by label selector
• --query: Search query
• --offset, --limit, --sort: For paging and sorting
• --show-all-labels: Show all labels for agents

Examples:

1# List all agents
2bindplane get agents
3
4# Get specific agent
5bindplane get agent <agent-id>
6
7# Get configurations with filtering
8bindplane get configurations --selector "platform=linux" # Defined selectors (key-value pairs)
9bindplane get configurations --query "linux" # Search query
10
11# Export configuration to YAML
12bindplane get configuration my-config --export --output yaml

apply

Apply resources from files or stdin.

1bindplane apply -f <file1.yaml> [file2.yaml ...]
2bindplane apply <directory>/**/*
3bindplane apply -

Flags:

• -f, --file: Path(s) to YAML file(s) specifying resources

Examples:

1# Apply from file
2bindplane apply -f my-config.yaml
3
4# Apply multiple files
5bindplane apply configs/*.yaml
6
7# Apply from stdin
8cat config.yaml | bindplane apply -

delete

Delete resources.

1bindplane delete -f <file.yaml>
2bindplane delete <resource-type> <name> [--force]
3bindplane delete agent <agent-ids> [--selector <label-query>] [--query <query>]
4bindplane delete organization <id> [--force]

Flags:

• -f, --file: Path to YAML file specifying resources
• --selector: Label selector for filtering
• --query: Query for filtering
• --force: Force deletion with no checks

Supported Resource Types:

• agent
• agent-type
• agent-version
• configuration
• source
• source-type
• processor
• processor-type
• connector
• connector-type
• destination
• destination-type
• extension
• extension-type
• recommendation-type
• project
• user
• recording
• fleet
• organization

Examples:

1# Delete by name
2bindplane delete configuration my-config
3
4# Delete agents by selector
5bindplane delete agent --selector "environment=staging"
6
7# Delete from file
8bindplane delete -f resources-to-delete.yaml

copy

Make a copy of a resource.

1bindplane copy configuration <source-config> <destination-config>

Aliases: cp

Examples:

1bindplane copy config my-config my-config-copy

Agent Version Management

update

Update existing agents.

1bindplane update agent <id> [--version <version>]

Aliases: upgrade

Flags:

• --version: Version of the agent to install (default: "latest")

Examples:

1# Update to latest version
2bindplane update agent agent-123
3
4# Update to specific version
5bindplane update update agent agent-123 --version v1.30.0

sync

Synchronize agent-versions from GitHub.

1bindplane sync agent-version [--agent-type <type>] [--version <version>] [--all]

Flags:

• --agent-type: Agent type to sync (default: "observiq-otel-collector")
• --version: Version to sync (default: "latest")
• --all: Sync all versions

Examples:

1# Sync latest version
2bindplane sync agent-version
3
4# Sync specific version
5bindplane sync agent-version --version v1.30.0
6
7# Sync all versions
8bindplane sync agent-version --all

upload

Upload offline agent upgrade packages.

1bindplane upload agent-upgrade <file> [--version <version>]

Examples:

1# Upload with auto-detected version
2bindplane upload agent-upgrade observiq-otel-collector-v1.30.0-artifacts.tar.gz
3
4# Upload with specified version
5bindplane upload agent-upgrade package.tar.gz --version v1.30.0

Agent Configuration Management

rollout

Manage configuration rollouts.

Start Flags:

• --all: Start rollout for every configuration
• --max-errors: Maximum errors before pausing
• --initial: Initial number of agents
• --multiplier: Multiplier for agent count
• --max: Maximum number of agents

Examples:

1# Start rollout with options
2bindplane rollout start my-config --max-errors 5 --initial 10 --multiplier 2 --max 100
3
4# Start all rollouts
5bindplane rollout start --all
6
7# Check status
8bindplane rollout status my-config

User & Organization Management

create

Create new projects or organizations.

1bindplane create project <name>
2bindplane create organization <organization-name>

Examples:

1bindplane create project my-project
2bindplane create organization my-org

add

Add users to Bindplane.

1bindplane add user --email <email> --name <username> [--create]

Flags:

• --email: Email address of the user
• --name: Username
• --create: Create the user if necessary

Examples:

1bindplane add user --email user@example.com --name username --create

System Administration

admin

Administrator commands for database maintenance.

Vacuum Flags:

• -y, --accept: Automatically accept the prompt
• -f, --full: Perform a full vacuum

Examples:

1# Show vacuum stats
2bindplane admin vacuum-stats
3
4# Perform vacuum with confirmation
5bindplane admin vacuum-analyze
6
7# Perform full vacuum without confirmation
8bindplane admin vacuum-analyze -y -f

migrate

Perform database migrations.

1bindplane migrate [version] [-y]

Flags:

• version: Specific version to migrate to
• -y, --accept: Automatically accept the prompt

Examples:

1# Migrate to latest
2bindplane migrate
3
4# Migrate to specific version
5bindplane migrate v1.30.0
6
7# Non-interactive migration
8bindplane migrate -y

secret

Manage secret keys for the current project.

Examples:

1# List all secret keys
2bindplane secret get
3
4# Add new secret key
5bindplane secret add
6
7# Set default key
8bindplane secret default my-key

Development & Utilities

profile

Manage Bindplane CLI profiles.

Examples:

1# Create and use a new profile
2bindplane profile create production
3bindplane profile use production
4
5# List all profiles
6bindplane profile list
7
8# Get current profile details
9bindplane profile get

label

Manage resource labels (currently agents only).

1bindplane label agent <id> [key=value ...] [flags]

Flags:

• --list: List labels for agent
• --overwrite: Overwrite existing labels
• --selector: Filter agents by label
• --query: Filter agents by query

Examples:

1# List agent labels
2bindplane label agent agent-123 --list
3
4# Add labels
5bindplane label agent agent-123 environment=production region=us-west
6
7# Remove label (set to empty)
8bindplane label agent agent-123 old-label-
9
10# Label multiple agents by selector
11bindplane label agent --selector "environment=staging" team=backend

Command Categories Summary

Getting Help

For detailed help on any command:

1bindplane <command> --help

For help on subcommands:

1bindplane <command> <subcommand> --help

Tips & Best Practices

1. Use profiles to manage different environments (dev, staging, production)
2. Use selectors and queries to filter resources efficiently
3. Export configurations before making changes: bindplane get configuration <name> --export > backup.yaml
4. Use rollouts for safe configuration deployments
5. Check resource status before deleting: bindplane get <resource-type> <name>
6. Use the --force flag carefully, especially with delete operations

This reference covers all available BindPlane CLI commands. For more detailed information about specific features or advanced usage, join the Bindplane Slack Community to get help from the team.