Skip to content

docs: Update flash login to document copy-paste API key flow #658

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

Draft
promptless wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

docs: Update flash login to document copy-paste API key flow #658

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05409f7
Update flash login flow docs and Python version requirements
promptless[bot] May 21, 2026
994a11e
Merge branch 'main' into promptless/flash-login-copy-paste-flow
promptless[bot] May 21, 2026
804797a
Resolve base-branch merge conflicts
promptless[bot] Jun 8, 2026
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
10 changes: 4 additions & 6 deletions flash/cli/login.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,23 @@ Authenticate with Runpod (opens browser automatically):
flash login
```

The command opens your default browser to the Runpod authorization page. After you approve the request, your API key is saved locally for future CLI operations.
The command opens your default browser to the Runpod authorization page. After you approve the request, you'll copy the API key from the browser and paste it into the CLI prompt.

@promptless promptless Bot Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the login flow description based on PR #337 which replaces polling-based authentication with a copy-paste flow. The PR removes the --timeout flag from login.py and the get_flash_auth_request_status polling method.

Source: runpod/flash#337


## How it works

1. Flash generates an authorization request.
2. Your browser opens to the Runpod console authorization page.
3. You approve the request in your browser.
4. Flash saves your API key to `~/.runpod/config.toml`.
4. The browser displays your API key.
5. You copy the key and paste it into the CLI prompt.
6. Flash saves your API key to `~/.runpod/config.toml`.

## Flags

<ResponseField name="--no-open">
Don't automatically open the browser. Instead, manually copy the authorization URL and open it yourself.
</ResponseField>

<ResponseField name="--timeout" type="float" default="600">
Maximum time in seconds to wait for authorization. Default is 600 seconds (10 minutes).
</ResponseField>

<ResponseField name="--force">
Force re-authentication even if credentials already exist. By default, `flash login` skips the browser flow when it finds existing credentials.
</ResponseField>
Expand Down
Loading