Fastly CLI

A CLI for interacting with the Fastly platform.

Quick links

• Installation
• Usage
• Bash/ZSH completion
• Development
• Issues

Installation

macOS

Homebrew

Install: brew install fastly/tap/fastly

Upgrade: brew upgrade fastly

Windows

scoop

Install:

scoop bucket add fastly-cli https://github.com/fastly/scoop-cli.git
scoop install fastly

Upgrade: scoop update fastly

Linux

Debian/Ubuntu Linux

Install and upgrade:

1. Download the .deb file from the releases page
2. sudo apt install ./fastly_*_linux_amd64.deb install the downloaded file

Fedora Linux

Install and upgrade:

1. Download the .rpm file from the releases page
2. sudo dnf install fastly_*_linux_amd64.rpm install the downloaded file

Centos Linux

Install and upgrade:

1. Download the .rpm file from the releases page
2. sudo yum localinstall fastly_*_linux_amd64.rpm install the downloaded file

openSUSE/SUSE Linux

Install and upgrade:

1. Download the .rpm file from the releases page
2. sudo zypper in fastly_*_linux_amd64.rpm install the downloaded file

From a prebuilt binary

Download the latest release from the releases page. Unarchive the binary and place it in your $PATH. You can verify the integrity of the binary using the SHA256 checksums file fastly_x.x.x_SHA256SUMS provided alongside the release.

Verify it works by running fastly version.

$ fastly version
Fastly CLI version vX.Y.Z (abc0001)
Built with go version go1.13.1 linux/amd64

The Fastly CLI will notify you if a new version is available, and can update itself via fastly update.

Usage

The Fastly CLI interacts with the Fastly API via an API token. You'll need to create an API token for yourself, and then provide it to the Fastly CLI in one of three ways:

1. Stored in a config file by running fastly configure
2. Explicitly via the --token, -t flag
3. Implicitly via the FASTLY_API_TOKEN environment variable

To see an overview of all commands, simply run fastly with no arguments. Succinct help about any command or subcommand is available via the -h, --help flag. Verbose help about any command or subcommand is available via the help argument, e.g. fastly help service.

Bash/ZSH shell completion

The CLI can generate completions for all commands, subcommands and flags.

By specifying --completion-bash as the first argument, the CLI will show possible subcommands. By ending your argv with --, hints for flags will be shown.

Configuring your shell

To install the completions source them in your bash_profile (or equivalent):

eval "$(fastly --completion-script-bash)"

Or for ZSH in your zshrc:

eval "$(fastly --completion-script-zsh)"

Development

The Fastly CLI requires Go 1.13 or above. Clone this repo to any path and type make to run all of the tests and generate a development build locally.

git clone git@github.com:fastly/cli
cd cli
make
./fastly version

The make task requires the following executables to exist in your $PATH:

• golint
• gosec
• staticcheck

If you have none of them installed, or don't mind them being upgraded automatically, you can run make dependencies to install them.

Contributing

Refer to CONTRIBUTING.md

Issues

If you encounter any non-security-related bug or unexpected behavior, please file an issue using the bug report template.

Security issues

Please see our SECURITY.md for guidance on reporting security-related issues.

License

Apache 2.0.