README
¶
Fastly CLI
A CLI for interacting with the Fastly platform.
Install
Homebrew
Install: brew install fastly/tap/fastly
Upgrade: brew upgrade fastly
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.
Use
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:
- Stored in a config file by running
fastly configure - Explicitly via the
--token, -tflag - Implicitly via the
FASTLY_API_TOKENenvironment 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.
Developing
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
Contributing
We're happy to receive feature requests and PRs. If your change is nontrivial, please open an issue to discuss the idea and implementation strategy before submitting a PR.
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
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
api
Package api provides abstractions for talking to the Fastly API.
|
Package api provides abstractions for talking to the Fastly API. |
|
app
Package app provides helpers for creating and running the CLI application.
|
Package app provides helpers for creating and running the CLI application. |
|
backend
Package backend contains commands to inspect and manipulate Fastly service backends.
|
Package backend contains commands to inspect and manipulate Fastly service backends. |
|
common
Package common contains general-purpose types and helpers.
|
Package common contains general-purpose types and helpers. |
|
compute
Package compute contains commands to manage Compute@Edge packages.
|
Package compute contains commands to manage Compute@Edge packages. |
|
config
Package config manages global configuration parameters.
|
Package config manages global configuration parameters. |
|
configure
Package configure contains commands to inspect and manipulate the CLI global confuguration.
|
Package configure contains commands to inspect and manipulate the CLI global confuguration. |
|
domain
Package domain contains commands to inspect and manipulate Fastly service domains.
|
Package domain contains commands to inspect and manipulate Fastly service domains. |
|
healthcheck
Package healthcheck contains commands to inspect and manipulate Fastly service healthchecks.
|
Package healthcheck contains commands to inspect and manipulate Fastly service healthchecks. |
|
logging
Package logging contains commands to inspect and manipulate Fastly service logging endpoints.
|
Package logging contains commands to inspect and manipulate Fastly service logging endpoints. |
|
logging/bigquery
Package bigquery contains commands to inspect and manipulate Fastly service BigQuery logging endpoints.
|
Package bigquery contains commands to inspect and manipulate Fastly service BigQuery logging endpoints. |
|
logging/s3
Package s3 contains commands to inspect and manipulate Fastly service S3 logging endpoints.
|
Package s3 contains commands to inspect and manipulate Fastly service S3 logging endpoints. |
|
mock
Package mock provides mock implementations of various interfaces.
|
Package mock provides mock implementations of various interfaces. |
|
service
Package service contains commands to inspect and manipulate Fastly services.
|
Package service contains commands to inspect and manipulate Fastly services. |
|
serviceversion
Package serviceversion contains commands to inspect and manipulate Fastly service versions.
|
Package serviceversion contains commands to inspect and manipulate Fastly service versions. |
|
testutil
Package testutil provides helpers for unit tests.
|
Package testutil provides helpers for unit tests. |