Roadie Local | Roadie

Prerequisites

Ensure your docker compose version is at least 2.23.1. If not, please update to the latest version using the official docs.
Ensure docker is running.

Installing

We provide 4 builds of the Roadie Local CLI. Please choose the build that best suits your system.

Mac Apple Silicon (ARM)

curl -o roadie-local "https://roadie.io/downloads/roadie-local/roadie-local-cli-v0.1.1-darwin-arm64" && chmod +x ./roadie-local

Mac Intel Chip

curl -o roadie-local "https://roadie.io/downloads/roadie-local/roadie-local-cli-v0.1.1-darwin-amd64" && chmod +x ./roadie-local

Linux (ARM)

curl -o roadie-local "https://roadie.io/downloads/roadie-local/roadie-local-cli-v0.1.1-linux-arm64" && chmod +x ./roadie-local

Linux (AMD)

curl -o roadie-local "https://roadie.io/downloads/roadie-local/roadie-local-cli-v0.1.1-linux-amd64" && chmod +x ./roadie-local

To test the installation, ensure this command displays help text.

./roadie-local -h

Getting Started

Initialize the environment and enter your license key

./roadie-local start
Enter your license key: <redacted>
✔ Validating license

Run Roadie Local

The following command will start Roadie on a URL. Open the URL in your browser.

roadie-local start
✔ Validating license
✔ Starting up Roadie from ~/.roadie/versions/docker-compose-v0.4.0.yaml

Roadie is available to access at http://localhost:8080

The following users are hard-coded to get you started.

Username	Password
admin	roadie
maintainer	roadie
reader	roadie

To restart Roadie Local

./roadie-local restart

To stop Roadie Local

./roadie-local stop

More command line options

Global Command Line Options

Flags:
      --debug                          Enable debug output. (default: false)
  -f, --dockerComposeFilePath string   Specify a custom docker-compose file path
  -h, --help                           help for roadie-local
  -k, --license string                 Roadie license key
  -s, --skipLicenseCheck               Skip the license check.

Debugging

In addition to command-specific options, the CLI supports a global --debug flag, which will print full command execution logs.

./roadie-local --debug start

The debug flag is especially helpful when troubleshooting deployment issues on different environments like EC2 instances, as it shows the complete Docker Compose command execution output.

Update the version of Roadie Local

./roadie-local version list
./roadie-local version use <version>
./roadie-local restart