About CLI Reference

GC CLI, or gc, is a developer tool to help you build, test and manage your integration with GoCardless directly from your terminal.

Installation

To install the GC CLI with homebrew run:
```
brew install gocardless/taps/cli
```
After installing you should have a gc binary available now.

In case `gc` is aliased to another command on your computer, homebrew also installs an alternate `gocardless` command that can be in place of `gc`. Try `gocardless version` for example.
To install the GC CLI on macOS without homebrew:
1. Download the latest macOS tar.gz file from https://github.com/gocardless/cli-releases/releases.
2. Unzip the file: tar -xvf cli_<version>_macOS_<arch>.tar.gz. <version> and <arch> will depend on which file you download.
3. Move ./gc to a location where you can execute it globally (typically /usr/local/bin)
The arm64 architecture is for the new M1 Macs, while the x86_64 architecture is for intel based Macs.
To install the GC CLI on Windows:
1. Download the latest Windows zip file from https://github.com/gocardless/cli-releases/releases.
2. Unzip the file: tar -xvf cli_<version>_Windows_<arch>.tar.gz. <version> and <arch> will depend on which file you download.
To install the GC CLI on linux without a package manager:
1. Download the latest Linux tar.gz file from https://github.com/gocardless/cli-releases/releases.
2. Unzip the file: tar -xvf cli_<version>_linux_<arch>.tar.gz. <version> and <arch> will depend on which file you download.
3. Move ./gc to an execution location.

The GC CLI is also available as a Docker image.

First set up a volume for the gc-cli container:

docker volume create gc_config

To login

docker run -v gc_config:/.gc-cli -p 8080:8080 --rm -it gocardless/gc-cli:latest login

To run commands

alias gc="docker run -v gc_config:/.gc-cli --rm -it gocardless/gc-cli:latest"
gc [command]