Skip to content

Commit

Permalink
Merge pull request #8 from DopplerHQ/tom_readme
Browse files Browse the repository at this point in the history
Add usage section to readme
  • Loading branch information
Piccirello authored Nov 13, 2019
2 parents 5604d95 + 6e159d4 commit 1109a8d
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,24 @@ You can download all binaries and release artifacts from the [Releases](https://

You can also directly download the generated `.deb` and `.rpm` packages. If a binary doesn't exist for the OS/architecture you use, please open a GitHub Issue.

## Usage

Once installed, you can access the Doppler CLI with the `doppler` command.

```sh
$ doppler configure set key=$YOUR_API_KEY # set local credentials
$ doppler setup # select your project and config
$ doppler configure --all # (optional) view local configuration
```

The first command will save your api key to the local configuration file, and it will be scoped to the current directory. You can modify this scope by specifying the `--scope` flag. See `doppler help configure set` for more info, or run `doppler configure --all` to view your current configuration.

For a list of all commands:

```sh
$ doppler help
```

## Development

### Build
Expand Down

0 comments on commit 1109a8d

Please sign in to comment.