Skip to content

Add new flags to wrangler login #21737

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

Merged
merged 2 commits into from
Apr 17, 2025
Merged

Add new flags to wrangler login #21737

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d525aea
add new flags
emily-shen Apr 16, 2025
dc52b6f
f
emily-shen Apr 16, 2025
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
23 changes: 14 additions & 9 deletions src/content/docs/workers/wrangler/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,9 +614,9 @@ wrangler secrets-store secret create <STORE_ID> [OPTIONS]
- A descriptive name for the account-level secret. Cannot contain spaces.
- `--value` <Type text="string" /> <MetaInfo text="test only" />
- Value of the secret.
:::caution[Only use for testing]
This will leave the secret value in plain-text in terminal history. For real secret values, use the automatic prompt instead. Find an example below.
:::
:::caution[Only use for testing]
This will leave the secret value in plain-text in terminal history. For real secret values, use the automatic prompt instead. Find an example below.
:::
- `--scopes` <Type text="string" /> <MetaInfo text="required" />
- Which services will have access to the account-level secret. Currently, only `workers` is available.
- `--comment` <Type text="string" /> <MetaInfo text="optional" />
Expand Down Expand Up @@ -652,9 +652,9 @@ wrangler secrets-store secret update <STORE_ID> [OPTIONS]
- The ID of the secret to update.
- `--value` <Type text="string" /> <MetaInfo text="test only" />
- Updated value of the secret.
:::caution[Only use for testing]
This will leave the secret value in plain-text in terminal history. For real secret values, use the automatic prompt instead.
:::
:::caution[Only use for testing]
This will leave the secret value in plain-text in terminal history. For real secret values, use the automatic prompt instead.
:::
- `--scopes` <Type text="string" /> <MetaInfo text="required" />
- Which services will have access to the account-level secret. Currently, only `workers` is available.
- `--comment` <Type text="string" /> <MetaInfo text="optional" />
Expand Down Expand Up @@ -1198,6 +1198,7 @@ wrangler pages functions build [<DIRECTORY>] [OPTIONS]
---

## `pipelines`

Manage your [Pipelines](/pipelines/).

<Render file="wrangler-commands/pipelines" product="workers" />
Expand Down Expand Up @@ -1365,17 +1366,21 @@ wrangler login [OPTIONS]

- `--scopes-list` <Type text="string" /> <MetaInfo text="optional" />
- List all the available OAuth scopes with descriptions.
- `--scopes $SCOPES` <Type text="string" /> <MetaInfo text="optional" />
- `--scopes` <Type text="string" /> <MetaInfo text="optional" />
- Allows to choose your set of OAuth scopes. The set of scopes must be entered in a whitespace-separated list,
for example, `npx wrangler login --scopes account:read user:read`.

<Render file="wrangler-commands/global-flags" product="workers" />
- `--callback-host` <Type text="string" /> <MetaInfo text="optional" />
- Defaults to `localhost`. Sets the IP or hostname where Wrangler should listen for the OAuth callback.
- `--callback-port` <Type text="string" /> <MetaInfo text="optional" />
- Defaults to `8976`. Sets the port where Wrangler should listen for the OAuth callback.

:::note

`wrangler login` uses all the available scopes by default if no flags are provided.
:::

<Render file="wrangler-commands/global-flags" product="workers" />

If Wrangler fails to open a browser, you can copy and paste the URL generated by `wrangler login` in your terminal into a browser and log in.

### Use `wrangler login` on a remote machine
Expand Down
Loading