Skip to content

Add wrangler flagship command documentation#31825

Draft
akshitsinha wants to merge 3 commits into
cloudflare:productionfrom
akshitsinha:asinha/wrangler-flagship
Draft

Add wrangler flagship command documentation#31825
akshitsinha wants to merge 3 commits into
cloudflare:productionfrom
akshitsinha:asinha/wrangler-flagship

Conversation

@akshitsinha

@akshitsinha akshitsinha commented Jul 1, 2026

Copy link
Copy Markdown
Member

Summary

Adds documentation for the new wrangler flagship CLI command group, which manages Flagship apps and feature flags from the command line.

This change adds:

  • A new reference page, flagship/reference/wrangler-commands, covering authentication, binding a Flagship app to a Worker, creating and inspecting apps and flags, targeting rules (including the compact rule syntax and --rule-json), rollouts and traffic splits, enabling and disabling flags, evaluating flags, changelog history, and scripting with --json output.
  • A new Wrangler command reference page at workers/wrangler/commands/flagship, consistent with how other Wrangler command groups are documented, that links to the fuller Flagship reference guide for complete workflows.
  • A link to the new reference page from the existing Flagship "Get started" guide.

Every wrangler flagship flags command takes the app ID as an explicit argument, so the documentation reflects that throughout rather than describing any implicit binding-based resolution.

Documentation checklist

@github-actions github-actions Bot added the product:workers Related to Workers product label Jul 1, 2026
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Review

⚠️ 4 warnings found in commit 9e6a0e9.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

Warnings (2)
File Issue
flagship/reference/wrangler-commands.mdx line 13 Inaccurate command signature description — Line 13 states every wrangler flagship flags command takes the app ID followed by the flag key, but the documented wrangler flagship flags list <APP_ID> (line 263) takes only an app ID with no flag key, so the claim is incorrect and could mislead users into passing an extra argument. Fix: Clarify that most wrangler flagship flags subcommands require a flag key after the app ID, while list-style commands such as flags list take only the app ID.
workers/wrangler/commands/flagship.mdx line 99 Inaccurate --force requirement for rollout/split — The sentence states rollout and split require --force when they would replace existing targeting rules, but the Flagship Wrangler commands reference says only rules with real conditions trigger a confirmation prompt; rules created by a previous rollout/split (no conditions) are replaced without a prompt. Fix: Clarify that --force is required only when rollout/split would overwrite existing targeting rules that have conditions.

Conventions

Checks PR title, description, and redirect checklist.

No convention issues found.

Style Guide Review

Warnings (2)
File Issue
flagship/reference/wrangler-commands.mdx line 40 WranglerConfig input must be TOML<WranglerConfig> wraps a ```jsonc block for the Flagship binding snippet. Fix: Provide the Wrangler configuration as ```toml inside <WranglerConfig>; JSONC output is auto-generated.
workers/wrangler/commands/flagship.mdx line 33 No contractions — Line uses the contraction don't in body prose Fix: Change don't to do not

Redirects

No missing redirect entries found.

Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.

@irvinebroque irvinebroque left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Changelog?

@MattieTK for review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:workers Related to Workers product size/l

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants