Rudder CLI Tool Alpha

This feature is in Alpha as part of RudderStack’s Early Access Program, where we work with early users and customers to test new features and get feedback before making them generally available. Note that these features are functional but can change as we improve them.

Make sure to contact the RudderStack team before using them in production.

The Rudder CLI tool lets you manage multiple RudderStack resources as code, including Tracking Plans and Data Catalog and SQL models for Reverse ETL. It provides a complete command-line interface for working with your YAML-defined configurations, enabling Git-based workflows for collaboration and version control.

Key features

This section highlights the key Rudder CLI features in terms of its core capabilities and usability.

Core capabilities

• Initialize and configure: Set up your Tracking Plan project structure with the necessary YAML templates.
• Create, update, and delete: Manage Data Catalog, Tracking Plan, and SQL model resources directly from your terminal.
• Bi-directional management: Create new resources from CLI or import existing resources from your workspace into Git.
• Validation and preview: Verify your YAML configurations locally, validate SQL syntax, and preview query results before pushing changes to production.
• Remote synchronization: Maintain consistency between your local files and your RudderStack workspace.

Supported resource types

The Rudder CLI tool manages different types of resources through YAML configurations:

Data governance

• Event definitions: Your events with names, descriptions, and categories
• Property definitions: Reusable properties with validation rules like minimum/maximum length, patterns, enums, etc.
• Tracking plan rules: Associations between events and their required properties
• Cross-references: Reuse properties across multiple events using the path reference system

See the CLI-based Tracking Plans Management for more details.

SQL models

• SQL model definitions: Reverse ETL SQL model sources with query logic, primary keys, and warehouse connections
• External SQL files: Reference external .sql files or define queries inline in YAML
• Import existing resources: Import existing SQL model resources from your workspace into Git

See the Manage SQL Models using Rudder CLI for more details.

CI/CD integration

• GitHub Actions support: Integrate validation and deployment steps in your GitHub workflows.
• Automated validation: Run configuration checks as part of your CI pipeline.
• Deployment automation: Push validated Tracking Plans to production.

Get started

Choose your workflow based on the resources you want to manage:

Tracking Plans and Data Catalog

1. Install the Rudder CLI tool in your preferred environment.
2. Authenticate the tool and configure access to your RudderStack workspace by creating a workspace-level Service Access Token.
3. Initialize a new tracking plan project with YAML definitions. Then, sync the changes to your workspace.
4. Automate tracking plan management using GitHub Actions.

SQL models

1. Install the Rudder CLI tool in your preferred environment.
2. Authenticate the tool and configure access to your RudderStack workspace by creating a workspace-level Service Access Token.
3. Set up your project directory and create new SQL model resources or import existing ones from your workspace.
4. Validate and preview your SQL models before deployment.
5. Automate SQL model management using GitHub Actions.

Questions? Contact us by Email or on Slack