The Gigalixir Command-Line Interface or CLI is a tool you install on your local machine to control Gigalixir.

How to Install the CLI

Homebrew on macOS

Prerequisites:

Install the CLI with:

brew tap gigalixir/brew
brew install gigalixir

When you get out of date, upgrade to the latest version with:

brew update
brew upgrade gigalixir

macOS

Prerequisites:

Install the CLI and add the executable to your path with:

pip3 install gigalixir --user
echo "export PATH=\$PATH:$(python3 -m site --user-base)/bin" >> ~/.profile
source ~/.profile

When you get out of date, upgrade to the latest version with:

pip3 install gigalixir --user --upgrade

Linux

Prerequisites:

For example, in a debian system you might run something like this:

sudo apt update
sudo apt install -y python3 python3-pip git-core curl

Install the CLI and add the executable to your path with:

pip3 install gigalixir --user
echo "export PATH=\$PATH:$(python3 -m site --user-base)/bin" >> ~/.profile
source ~/.profile

When you get out of date, upgrade to the latest version with:

pip3 install gigalixir --user --upgrade

Windows

Prerequisites:

Install the CLI with:

pip3 install gigalixir --user

Make sure the executable is in your path, if it isn’t already.

On Windows Powershell, try something similar to this. Note this may vary based on your python version.

[Environment]::SetEnvironmentVariable("Path", $env:Path + ";$HOME\appdata\roaming\python\python38\Scripts", "Machine")

If you have any trouble, please reach out for help.

When you get out of date, upgrade to the latest version with:

pip3 install gigalixir --user --upgrade

How to Upgrade the CLI

Homebrew on macOS

brew update
brew upgrade gigalixir

macOS

pip3 install gigalixir --user --upgrade

Linux

pip3 install gigalixir --user --upgrade

Windows

pip3 install gigalixir --user --upgrade

Encryption

All HTTP requests made between your machine and Gigalixir’s servers are encrypted.

Conventions

  • No news is good news: If you run a command that produces no output, then the command probably succeeded.
  • Exit codes: Commands that succeed will return a 0 exit code, and non-zero otherwise.
  • stderr vs stdout: Stderr is used for errors and for log output. Stdout is for the data output of your command.

Authentication

When you login with your email and password, you receive an API key.

This API key is stored in your ~/.netrcfile. Commands generally use your ~/.netrc file to authenticate with few exceptions.

Error Reporting

Bugs in the CLI are reported to Gigalixir’s error tracking service. Currently, the only way to disable this is by modifying the source code.

Pull requests are also accepted!

Open Source

The Gigalixir CLI is open source and we welcome pull requests. See the gigalixir-cli repository.

NEXT ⟶