rudder-cli

Table of Contents

• ⚠️ Work in Progress
• Installation
  • MacOS
    • Apple Silicon
    • Intel-based
  • Linux
  • Docker
  • Build from Source

⚠️ Work in Progress

Warning

Please note that this tool is currently a work in progress. We are actively developing and improving it, and as such, there may be frequent changes and updates. We do not guarantee backwards compatibility at this stage.

Installation

MacOS

Apple Silicon

curl -L https://github.com/rudderlabs/rudder-iac/releases/latest/download/rudder-cli_Darwin_arm64.tar.gz | tar -xz rudder-cli
sudo mv rudder-cli /usr/local/bin/

Intel-based

curl -L https://github.com/rudderlabs/rudder-iac/releases/latest/download/rudder-cli_Darwin_x86_64.tar.gz | tar -xz rudder-cli
sudo mv rudder-cli /usr/local/bin/

Linux

curl -L https://github.com/rudderlabs/rudder-iac/releases/latest/download/rudder-cli_Linux_x86_64.tar.gz | tar -xz rudder-cli
sudo mv rudder-cli /usr/local/bin/

Docker

You can run the CLI directly using Docker:

docker run rudderlabs/rudder-cli

If you need to persist your configuration, or provide an external configuration file, you can mount your local config directory into the container. Assuming your config directory is located at ~/.rudder, you can run the following command:

docker run -v ~/.rudder:/.rudder rudderlabs/rudder-cli

To run commands with local catalog files, mount your files directory and use the -l flag. For example:

docker run -v ~/.rudder:/.rudder -v ~/my-catalog:/catalog rudderlabs/rudder-cli tp apply --dry-run -l /catalog

This will use the access token from your local configuration file, and the catalog files from the /catalog directory. Alternatively, you can use the RUDDERSTACK_ACCESS_TOKEN environment variable to provide the access token:

docker run -v ~/my-catalog:/catalog -e RUDDERSTACK_ACCESS_TOKEN=your-access-token rudderlabs/rudder-cli tp apply --dry-run -l /catalog

Build from Source

To build the rudder-cli from source, you need to have Go installed. Then, run the following commands:

git clone https://github.com/rudderlabs/rudder-iac.git
cd rudder-iac
make build
sudo mv bin/rudder-cli /usr/local/bin/

To build the Docker image locally:

make docker-build