Skip to main content

CLI

This guide covers deploying Marmot using the command-line interface.

Installation​

Automatic Installation​

You can install Marmot with the automatic installation script, it's strongly recommended you inspect the contents of any script before piping it into bash.

curl -fsSL get.marmotdata.io | sh

Manual Installation​

If you prefer to install manually:

  1. Download the latest Marmot binary for your platform from GitHub Releases
  2. Make the binary executable: 
    chmod +x marmot
  3. Move the binary to a location in your PATH: 
    sudo mv marmot /usr/local/bin/

Running Marmot​

marmot run --config /path/to/config.yaml

The default username and password is admin:admin

Configuration​

Create a config.yaml file with your database connection details. You can read more about available configuration options here.

database:
  host: localhost
  port: 5432
  user: postgres
  password: password
  name: marmot