CLI Overview

The XDR Data Engine CLI (xdrcli) provides comprehensive command-line tools for managing all aspects of the XDR Data Engine. This guide provides an overview of available commands organized by their function.

Command Categories

Configuration Management

• init_target - Initialize or update configuration
• list_targets - List all configuration profiles
• print_default_target - Display default target configuration

Schema Management

• build-schemas - Build ClickHouse schemas
• apply-schemas - Apply schemas to ClickHouse
• plan-schemas - Preview schema changes
• modify-orderby-table - Modify table ORDER BY clause

Ingestion Pipeline Management

• build-ingestion-pipelines - Build ingestion pipelines
• list_ingestion_templates - List available templates
• upload_ingestion_pipeline_core_config - Upload core configurations
• upload_ingestion_pipeline_templates - Upload pipeline templates
• upload_ingestion_pipeline_maxmind_mmdb - Upload MaxMind databases

Hunt Operations

• run-hunt - Execute hunt operations
• list-hunts - List active hunts
• view-hunts - View hunt details
• kill-hunt - Terminate specific hunt
• kill-all-hunts - Terminate all hunts
• print-hunt-parameters - Display hunt parameters

Schema Utilities

• list_schema_fields - List schema fields
• describe_xdr_clickhouse_schema_types - Display schema types
• schema-version-generator - Generate schema versions
• schema-version-executor - Execute versioned schemas

Package Management

• download_meta_schemas - Download core schemas
• download_vector_templates - Download vector templates
• list_meta_schemas - List available schemas

System Operations

• is_hunt_scheduler_healthy - Check system health

Getting Started

For detailed information about each command, including parameters and examples, see the Complete CLI Reference.

For information about command parameters, see the CLI Parameters Reference.