# Rudder CLI Setup

> Installs and authenticates rudder-cli. Use when installing rudder-cli, setting up rudder cli, rudder-cli command not found, or authenticating with RudderStack

- Skill: `rudderlabs/rudder-cli-setup` (Agent Skill)
- Install (CLI): `npx skillmds@latest add rudderlabs/rudder-cli-setup`
- Raw SKILL.md: https://api.skillmd.com/api/skills/rudderlabs/rudder-cli-setup/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: rudderlabs (https://skillmd.com/u/rudderlabs)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/rudderlabs/rudder-cli-setup

---


# Rudder CLI Setup

Install rudder-cli, authenticate with RudderStack, and verify the setup works.

## Setup Workflow

```
1. Check Installation ──► which rudder-cli
         │
         ├── Found ──► Skip to Authentication
         │
         └── Not Found ──► Install from GitHub Releases
                                    │
2. Verify Installation ◄────────────┘
         │
         └── rudder-cli --version

3. Check Authentication ──► rudder-cli workspace info
         │
         ├── Authenticated ──► Done! Show workspace info
         │
         └── Not Authenticated ──► Guide through auth flow
```

## Step 1: Check if Installed

```bash
which rudder-cli
```

**If found:** Skip to Step 3 (Authentication).

**If not found:** Continue to Step 2 (Installation).

## Step 2: Install rudder-cli

### Detect Operating System

```bash
uname -s
```

- `Darwin` = macOS
- `Linux` = Linux

### Download from GitHub Releases

Go to: https://github.com/rudderlabs/rudder-iac/releases

Download the appropriate binary for your OS and architecture:

| OS | Architecture | Binary Name |
|----|--------------|-------------|
| macOS | Intel | `rudder-cli_darwin_amd64` |
| macOS | Apple Silicon | `rudder-cli_darwin_arm64` |
| Linux | x86_64 | `rudder-cli_linux_amd64` |
| Linux | ARM64 | `rudder-cli_linux_arm64` |
| Windows | x86_64 | `rudder-cli_windows_amd64.exe` |

### Installation Commands (macOS/Linux)

```bash
# Example for macOS Apple Silicon - adjust URL for your platform
# Check latest version at https://github.com/rudderlabs/rudder-iac/releases

# Download (replace VERSION and BINARY with actual values)
curl -L -o rudder-cli https://github.com/rudderlabs/rudder-iac/releases/download/VERSION/BINARY

# Make executable
chmod +x rudder-cli

# Move to PATH (choose one)
sudo mv rudder-cli /usr/local/bin/    # System-wide
# OR
mv rudder-cli ~/.local/bin/           # User-only (ensure ~/.local/bin is in PATH)
```

### Verify Installation

```bash
rudder-cli --version
```

Expected output: Version number (e.g., `rudder-cli version 0.x.x`)

## Step 3: Authenticate

### Check Current Status

```bash
rudder-cli workspace info
```

**If authenticated:** Shows workspace name and ID. You're done!

**If not authenticated:** Continue with authentication.

### Get Access Token

1. Log in to your RudderStack dashboard
2. Go to **Settings → Access Tokens**
3. Click **Generate New Token**
4. Copy the token (you won't see it again)

### Run Authentication

```bash
rudder-cli auth login
```

This prompts for your access token. Paste it when asked.

### Verify Authentication

```bash
rudder-cli workspace info
```

Expected output:
```
Workspace Information:
  ID:   2iKXWU4QnqclkpPIfXfsbBqrAVa
  Name: My Workspace
```

## Credential Security

- **Never echo or log your access token**
- Store tokens in environment variables if needed: `RUDDER_ACCESS_TOKEN`
- Add `.env` files to `.gitignore`
- For CI/CD, use repository secrets
- Rotate tokens periodically in the RudderStack dashboard

## Troubleshooting

| Issue | Solution |
|-------|----------|
| `command not found` after install | Check PATH includes install location |
| `unauthorized` error | Re-run `rudder-cli auth login` with new token |
| Wrong workspace | Token is tied to workspace; generate new token in correct workspace |
| Download fails | Check network; try browser download from releases page |

## Next Steps

After setup completes:
- Run `/rudder-environment-check` to verify full environment
- Start with `/rudder-cli-workflow` for validate → dry-run → apply cycles