Skip to content
This repository was archived by the owner on Apr 29, 2020. It is now read-only.

Latest commit

 

History

History
39 lines (23 loc) · 1.26 KB

File metadata and controls

39 lines (23 loc) · 1.26 KB

Dyn CLI utils

CircleCI

Utilities for interacting with the dynect API. This is not intended as a fully featured Dyn CLI client - just a collection of useful utilities which make working with Dyn easier.

To install run:

go get github.com/Financial-Times/dyn-cli-utils

To view the available commands run:

dyn-cli-utils --help

or view the generated documentation at docs.

Configuration

Configuration is accepted as either command line flags (e.g. --log-level), environment variables (e.g LOG_LEVEL), or as a config file located at either$HOME/.dyn-cli-utilsor the givenconfig` path.

If a config file is provided, any of the following formats are supported: JSON, TOML, YAML, HCL, and Java properties.

Development

Run make help to see available Make commands.

After making a CLI API change, please run make docs to regenerate static markdown documentation. These changes should be commited.

To run CLI commands, run

go run main.go [command]

or install the package to your $GOBIN directory with go install and then use dyn-cli-utils as above.