LogoLogo
WarpStream.comSlackDiscordContact UsCreate Account
  • Overview
    • Introduction
    • Architecture
      • Service Discovery
      • Write Path
      • Read Path
      • Life of a Request (Simplified)
    • Change Log
  • Getting Started
    • Install the WarpStream Agent / CLI
    • Run the Demo
    • "Hello World" for Apache Kafka
  • BYOC
    • Run the Agents Locally
    • Deploy the Agents
      • Object Storage Configuration
      • Kubernetes Known Issues
      • Rolling Restarts and Upgrades
    • Infrastructure as Code
      • Terraform Provider
      • Helm charts
      • Terraform Modules
    • Monitoring
      • Pre-made Datadog Dashboard
      • Pre-made Grafana Dashboard
      • Important Metrics and Logs
      • Recommended List of Alerts
      • Monitoring Consumer Groups
      • Hosted Prometheus Endpoint
    • Client Configuration
      • Tuning for Performance
      • Configure Clients to Eliminate AZ Networking Costs
        • Force Interzone Load Balancing
      • Configuring Kafka Client ID Features
      • Known Issues
    • Authentication
      • SASL Authentication
      • Mutual TLS (mTLS)
      • Basic Authentication
    • Advanced Agent Deployment Options
      • Agent Roles
      • Agent Groups
      • Protect Data in Motion with TLS Encryption
      • Low Latency Clusters
      • Network Architecture Considerations
      • Agent Configuration Reference
      • Reducing Infrastructure Costs
      • Client Configuration Auto-tuning
    • Hosted Metadata Endpoint
    • Managed Data Pipelines
      • Cookbooks
    • Schema Registry
      • WarpStream BYOC Schema Registry
      • Schema Validation
      • WarpStream Schema Linking
    • Port Forwarding (K8s)
    • Orbit
    • Enable SAML Single Sign-on (SSO)
    • Trusted Domains
    • Diagnostics
      • GoMaxProcs
      • Small Files
  • Reference
    • ACLs
    • Billing
      • Direct billing
      • AWS Marketplace
    • Benchmarking
    • Compression
    • Protocol and Feature Support
      • Kafka vs WarpStream Configuration Reference
      • Compacted topics
    • Secrets Overview
    • Security and Privacy Considerations
    • API Reference
      • API Keys
        • Create
        • Delete
        • List
      • Virtual Clusters
        • Create
        • Delete
        • Describe
        • List
        • DescribeConfiguration
        • UpdateConfiguration
      • Virtual Clusters Credentials
        • Create
        • Delete
        • List
      • Monitoring
        • Describe All Consumer Groups
      • Pipelines
        • List Pipelines
        • Create Pipeline
        • Delete Pipeline
        • Describe Pipeline
        • Create Pipeline Configuration
        • Change Pipeline State
      • Invoices
        • Get Pending Invoice
        • Get Past Invoice
    • CLI Reference
      • warpstream agent
      • warpstream demo
      • warpstream cli
      • warpstream playground
    • Integrations
      • Arroyo
      • AWS Lambda Triggers
      • ClickHouse
      • Debezium
      • Decodable
      • DeltaStream
      • docker-compose
      • DuckDB
      • ElastiFlow
      • Estuary
      • Fly.io
      • Imply
      • InfluxDB
      • Kestra
      • Materialize
      • MinIO
      • MirrorMaker
      • MotherDuck
      • Ockam
      • OpenTelemetry Collector
      • ParadeDB
      • Parquet
      • Quix Streams
      • Railway
      • Redpanda Console
      • RisingWave
      • Rockset
      • ShadowTraffic
      • SQLite
      • Streambased
      • Streamlit
      • Timeplus
      • Tinybird
      • Upsolver
    • Partitions Auto-Scaler (beta)
    • Serverless Clusters
Powered by GitBook
On this page
  • warpstream cli
  • Examples

Was this helpful?

  1. Reference
  2. CLI Reference

warpstream cli

warpstream cli

The warpstream cli subcommand can be used to interact with a WarpStream cluster. It provides similar capabilities as the Apache Kafka command line tools for administering a Kafka cluster.

The following table displays the available warpstream cli arguments. Be sure to start with the subcommand needed from the -type list below

Argument
Description

-bootstrap-host

Kafka bootstrap host Default: localhost

-bootstrap-port

Kafka bootstrap port Default: 9092

-client-id

Client ID to pass along to WarpStream Default: kcmd

-config-name

name of configuration to update

-config-value

new configuration value to set for configuration specified by -config-name flag

-diagnose-retry-attempts

number of retry attempts for diagnose-connection Default: 2

-group

Group to perform an operation on

-key

Key to use for the produced kafka records

-offset

Offset to consume from (used in conjunction with the -fetch subcommand) (optional)

-partition

Partition to consume from (used in conjunction with the -fetch subcommand) (optional)

-partition-count

Number of partitions to create (used in conjunction with the -topic -create subcommands) (optional)

-password

Password for SASL PLAIN authentication

-records

Double comma (,,) separated strings to produce as records (used in conjunction with the -produce subcommand)

-scram

uses scram authentication instead of the default SASL PLAIN

-timestamp list-offsets

Timestamp to use for the list-offsets request type

-tls

Dial with TLS or not

-tlsClientCertFile

path to X.509 certificate file in PEM format for the client

-tlsClientPrivateKeyFile

path to the X.509 private key file in PEM format for the client

-tlsServerCACertFile

path to the X.509 certificate file in PEM format for the server certificate authority. Default will use the host's root certificate pool

-topic

Topic name

-topic-cleanup-policy

Kafka topic cleanup policy, one of: [delete, compact] Default: delete

-type

Can be one of: produce, fetch, diagnose-connection, create-topic, list-topics, delete-topic, fetch-offsets, describe-groups, broker-metadata, commit-offsets, list-groups, describe-group, list-offsets

-username

Username for SASL PLAIN authentication

Examples

Diagnose Connection

warpstream cli diagnose-connection -bootstrap-host <bootstrap URL>

Create a topic

warpstream cli create-topic -topic <topic name>

Adjust topic configuration

warpstream cli alter-topic-config -topic <topic name> -config-name retention.ms -config-value 259200000

Consume from a topic

warpstream cli console-consumer -bootstrap-host <warpstream service> -topic <topic name>
Previouswarpstream demoNextwarpstream playground

Last updated 3 months ago

Was this helpful?