Skip to content

Commit 070edfd

Browse files
committed
Cleanup readme intro
1 parent 58e3e5b commit 070edfd

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,29 @@
33
Backend services and tools for processing and managing RFDs
44

55
## RFD CLI
6-
76
### Getting Started
8-
97
1. Download the latest release of `rfd-cli` or run `cargo run -p rfd-cli`
108
2. Configure the API host with `rfd-cli config set host https://rfd-api.shared.oxide.computer`
9+
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).
1110

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

15-
3. Authenticate against the API with `rfd-cli auth login google` via a session
17+
#### Authenticate with long lived token
18+
To generate and log in with a long lived token run:
19+
```sh
20+
rfd-cli auth login google -m token
21+
```
1622

17-
**OR**
23+
### Formatting
24+
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:
1825

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

2130
## Backend
2231

0 commit comments

Comments
 (0)