Skip to content

docs(cli-generator): document built-in auth command merging #6485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −2
Open

docs(cli-generator): document built-in auth command merging #6485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion fern/products/cli-generator/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Declaring an `oauth` scheme under `auth-schemes` in `generators.yml` makes the C
| Authorization code with Proof Key for Code Exchange (PKCE) | `authorization-code` | Interactive login. The CLI opens a browser and receives the callback on a loopback listener. |
| Device code | `device-code` | Interactive login on machines without a browser, such as SSH sessions and containers. |

The interactive flows are public-client only: they use PKCE rather than a client secret. They require CLI generator `0.29.0` or later.
The interactive flows are public-client only: they use PKCE rather than a client secret. They require CLI generator `0.30.0` or later. PKCE always applies to the `authorization-code` flow, with `S256` as the only supported challenge method.

### Log in and out

Expand All @@ -74,6 +74,8 @@ my-cli auth logout # remove the stored credential

Tokens are stored in the OS keyring, refreshed automatically when they expire, and sent as `Authorization: Bearer <token>` on every request. Pass `--no-browser` to `auth login` to print the authorization URL instead of opening a browser, and `--with-token` to skip the flow and read a token from stdin.

An API that defines its own `auth` operations keeps them. The built-in `login`, `logout`, and `status` commands are folded into the spec-defined group, so both `my-cli auth me` and `my-cli auth login` dispatch correctly. The built-in `completion` and `man` commands merge the same way. When a spec operation resolves to exactly `auth login`, `auth logout`, or `auth status`, the built-in wins; rename the operation with [`x-fern-sdk-method-name`](/learn/cli-generator/get-started/openapi-extensions#x-fern-sdk-method-name) to keep it reachable. Merging requires CLI generator `0.29.1` or later.

### Authorization code with PKCE

```yaml title="generators.yml"
Expand Down
2 changes: 1 addition & 1 deletion fern/products/cli-generator/openapi-extensions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ paths:
x-fern-sdk-method-name: get-current-user
```

Produces: `cli get-current-user` (or nested under a group if `x-fern-sdk-group-name` is also set).
Produces: `cli get-current-user` (or nested under a group if `x-fern-sdk-group-name` is also set). Renaming also resolves a collision with a [built-in command](/learn/cli-generator/get-started/authentication#log-in-and-out), such as an operation that resolves to `auth login`.

<Note>
If neither extension is present, the CLI falls back to the `operationId`.
Expand Down
Loading