WranglerCommand

The WranglerCommand component documents the available options for a given command.

This is generated using the Wrangler version in the cloudflare-docs repository ↗︎.

import { WranglerCommand } from "~/components";

import { WranglerCommand } from "~/components";

<WranglerCommand
	command="deploy"
	description={"Deploy a [Worker](/workers/)"}
/>

<WranglerCommand command="d1 execute" />

<WranglerCommand command="deploy" cfCommand="deploy" />

<WranglerCommand
	command="d1 execute"
	cfCommand={["d1 query", "d1 raw"]}
	includeHiddenCf
/>

You can add or replace help text for specific flags using the ExtraFlagDetails component:

import { WranglerCommand } from "~/components";
import ExtraFlagDetails from "~/components/cf/ExtraFlagDetails.astro";

<WranglerCommand command="deploy">
	<ExtraFlagDetails key="dry-run">
		Additional details about the dry-run flag that will be appended to the
		original help text. Here is a [link](https://cloudflare.com) for more
		information.
	</ExtraFlagDetails>
	<ExtraFlagDetails key="compatibility-date" mode="replace">
		Custom help text that completely replaces the original description for this
		flag.
	</ExtraFlagDetails>
</WranglerCommand>

• command string required
  • The name of the command, i.e d1 execute.
• headingLevel number (default: 2) optional
  • The heading level that the command name should be added at on the page, i.e 2 for a h2.
• description string optional
  • A description to render below the command heading. If not set, defaults to the value specified in the Wrangler help API.
• cfCommand string | string[] optional
  • One or more reviewed Cloudflare CLI equivalents without the cf prefix. Supplying this prop displays the shared CLI selector. Explain partial or non-equivalent workflows in the surrounding page content.
• includeHiddenCf boolean (default: false) optional
  • Allows explicitly reviewed cfCommand values that the installed Cloudflare CLI marks as hidden.