Skip to content

Commit

Permalink
Cleanup readme intro
Browse files Browse the repository at this point in the history
  • Loading branch information
augustuswm committed Apr 3, 2024
1 parent 58e3e5b commit 070edfd
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,29 @@
Backend services and tools for processing and managing RFDs

## RFD CLI

### Getting Started

1. Download the latest release of `rfd-cli` or run `cargo run -p rfd-cli`
2. Configure the API host with `rfd-cli config set host https://rfd-api.shared.oxide.computer`
3. Choose an authentication mode based on the kind of session you want, either a short-term session token (id) or a long-term api token (token).

Choose an authentication mode based on the kind of session you want, either a short-term session
token (id) or a long-term api token (token).
#### Authenticate with short lived session
To log in with a short lived session run:
```sh
rfd-cli auth login google
```

3. Authenticate against the API with `rfd-cli auth login google` via a session
#### Authenticate with long lived token
To generate and log in with a long lived token run:
```sh
rfd-cli auth login google -m token
```

**OR**
### Formatting
Results can be output either as machine (JSON) or human (tab) readable formats. A format can be specified per call via the `--format` argument. To persist this setting and apply it to call calls, it can be set in your config file via:

3. Authenticate against the API with `rfd-cli auth login google -m token` via a token
```sh
rfd-cli config set format <FORMAT>
```

## Backend

Expand Down

0 comments on commit 070edfd

Please sign in to comment.