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 is a part of RudderStack’s Git-based Tracking Plans Management feature. It lets you manage your tracking plans and data catalog as code, providing a complete command-line interface for working with your YAML-defined tracking plan configuration.

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 and tracking plan resources directly from your terminal.
• Validation: Verify your YAML configurations locally before pushing changes to production.
• Remote synchronization: Maintain consistency between your local files and your RudderStack workspace.

YAML structures

The Rudder CLI tool processes your YAML files that define:

• 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: You can reuse properties across multiple events using the path reference system.

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

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.

Questions? Contact us by email or on Slack