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

bindplane [command] [flags]

Help

Get help for any command:

bindplane <command> --help

Version Information

bindplane version

Displays both server and client version details.

---

Core Commands

init / initialize

Initialize a Bindplane installation.

Command	Description	Usage
init server	Initialize a new server installation	bindplane init server
init client	Initialize a new client installation	bindplane init client
init ldap	Initialize and migrate to LDAP configuration	bindplane init ldap
init auth	Initialize and migrate authentication	bindplane init auth
init license	Set license key in configuration	bindplane init license

serve

Start the Bindplane server.

bindplane 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:

bindplane 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:

# List all agents
bindplane get agents

# Get specific agent
bindplane get agent <agent-id>

# Get configurations with filtering
bindplane get configurations --selector "platform=linux" # Defined selectors (key-value pairs)
bindplane get configurations --query "linux" # Search query

# Export configuration to YAML
bindplane get configuration my-config --export --output yaml

apply

Create or update (upsert) any resource in Bindplane from files or stdin. The apply command is the primary method for managing all Bindplane resources. It will create new resources if they don't exist, or update existing resources if they do.

Syntax:

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

Flags:

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

Supported Resource Types:

The apply command works with all Bindplane resources:

• 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

• organizations / organization - Organizations

• accounts / account - Projects/accounts

• users / user - Users

• fleets / fleet - Agent fleets

Examples:

# Create or update a configuration
bindplane apply -f my-config.yaml

# Apply multiple resource files
bindplane apply configs/*.yaml

# Apply from stdin
cat config.yaml | bindplane apply -

# Apply all YAML files in a directory
bindplane apply ./resources/**/*.yaml

Important Notes:

• Upsert Behavior: apply will create new resources if they don't exist, or update existing resources if they do

• Idempotent: You can safely run apply multiple times on the same resources

• File Format: Resources must be specified in YAML format

• Resource Identification: Resources are identified by their name field in the YAML

delete

Delete resources.

bindplane delete -f <file.yaml>
bindplane delete <resource-type> <name> [--force]
bindplane delete agent <agent-ids> [--selector <label-query>] [--query <query>]
bindplane 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:

# Delete by name
bindplane delete configuration my-config

# Delete agents by selector
bindplane delete agent --selector "environment=staging"

# Delete from file
bindplane delete -f resources-to-delete.yaml

copy

Make a copy of a resource.

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

Aliases: cp

Examples:

bindplane copy config my-config my-config-copy

---

Agent Version Management

update

Update existing agents.

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

Aliases: upgrade

Flags:

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

Examples:

# Update to latest version
bindplane update agent agent-123

# Update to specific version
bindplane update update agent agent-123 --version v1.30.0

sync

Synchronize agent-versions from GitHub.

bindplane 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:

# Sync latest version
bindplane sync agent-version

# Sync specific version
bindplane sync agent-version --version v1.30.0

# Sync all versions
bindplane sync agent-version --all

upload

Upload offline agent upgrade packages.

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

Examples:

# Upload with auto-detected version
bindplane upload agent-upgrade observiq-otel-collector-v1.30.0-artifacts.tar.gz

# Upload with specified version
bindplane upload agent-upgrade package.tar.gz --version v1.30.0

---

Agent Configuration Management

rollout

Manage configuration rollouts.

Command	Description	Usage
rollout update	Update a rollout	bindplane rollout update [configuration]
rollout start	Start a rollout	bindplane rollout start <configuration> [flags]
rollout pause	Pause a rollout	bindplane rollout pause <configuration>
rollout resume	Resume a rollout	bindplane rollout resume <configuration>
rollout status	Get rollout status	bindplane rollout status <configuration>

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:

# Start rollout with options
bindplane rollout start my-config --max-errors 5 --initial 10 --multiplier 2 --max 100

# Start all rollouts
bindplane rollout start --all

# Check status
bindplane rollout status my-config

---

User & Organization Management

create

Create new projects or organizations.

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

Examples:

bindplane create project my-project
bindplane create organization my-org

add

Add users to Bindplane.

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

Flags:

• --email: Email address of the user

• --name: Username

• --create: Create the user if necessary

Examples:

bindplane add user --email [email protected] --name username --create

---

System Administration

admin

Administrator commands for database maintenance.

Command	Description	Usage
admin vacuum-stats	Display vacuum statistics	bindplane admin vacuum-stats
admin vacuum-analyze	Vacuum and analyze database	bindplane admin vacuum-analyze [-y] [-f]

Vacuum Flags:

• -y, --accept: Automatically accept the prompt

• -f, --full: Perform a full vacuum

Examples:

# Show vacuum stats
bindplane admin vacuum-stats

# Perform vacuum with confirmation
bindplane admin vacuum-analyze

# Perform full vacuum without confirmation
bindplane admin vacuum-analyze -y -f

migrate

Perform database migrations.

bindplane migrate [version] [-y]

Flags:

• version: Specific version to migrate to

• -y, --accept: Automatically accept the prompt

Examples:

# Migrate to latest
bindplane migrate

# Migrate to specific version
bindplane migrate v1.30.0

# Non-interactive migration
bindplane migrate -y

secret

Manage secret keys for the current project.

Command	Description	Usage
secret get	Get secret keys	bindplane secret get
secret add	Add a secret key	bindplane secret add
secret delete	Delete a secret key	bindplane secret delete <key>
secret default	Set default secret key	bindplane secret default <key>

Examples:

# List all secret keys
bindplane secret get

# Add new secret key
bindplane secret add

# Set default key
bindplane secret default my-key

---

Development & Utilities

profile

Manage Bindplane CLI profiles.

Command	Description	Usage
profile get	Get profile details	bindplane profile get [name]
profile set	Set profile details	bindplane profile set [name]
profile create	Create a new profile	bindplane profile create <name>
profile delete	Delete a profile	bindplane profile delete <name>
profile list	List all profiles	bindplane profile list
profile use	Use a profile	bindplane profile use <name>
profile current	Show current profile	bindplane profile current

Examples:

# Create and use a new profile
bindplane profile create production
bindplane profile use production

# List all profiles
bindplane profile list

# Get current profile details
bindplane profile get

label

Manage resource labels (currently agents only).

bindplane 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:

# List agent labels
bindplane label agent agent-123 --list

# Add labels
bindplane label agent agent-123 environment=production region=us-west

# Remove label (set to empty)
bindplane label agent agent-123 old-label-

# Label multiple agents by selector
bindplane label agent --selector "environment=staging" team=backend

---

Command Categories Summary

Category	Commands
Core	init, serve, version
Resources	get, apply, delete, copy
Agents	update, sync, upload
Configurations	rollout
Users & Orgs	create, add
Administration	admin, migrate, secret
Utilities	profile, label

---

Getting Help

For detailed help on any command:

bindplane <command> --help

For help on subcommands:

bindplane <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.