Skip to content

Conversation

@alsuren
Copy link
Contributor

@alsuren alsuren commented Nov 24, 2025

Fixes CFSQL-1406.

Describe your change...

The intention is to use the output of this in @Oxyjun's cloudflare/cloudflare-docs#26602

There are 3 commits:

  • copy some wrangler d1 help text from cloudflare docs site
    • Specifically https://developers.cloudflare.com/d1/wrangler-commands
    • I used my judgement here about which descriptions were best. Some descriptions were a bit too wordy. The output you want from --help ideally wants to be slightly more terse than what you want for a website, but compromises need to be made.
    • there were a few links that I didn't copy. I will add screenshots below. I added a few to the epilogue, but I will decide whether to do the same for the rest
  • reorder D1 commands to match cloudflare docs site
    • This is pretty un-controversial. The order on the docs site is much more sensible
    • I dragged the experimental wrangler d1 insights down to the bottom.
  • explicitly state whether D1 commands act on local/remote by default
    • I thought about doing this as "(default)" on the --local and --remote flags themselves, but that looked a bit strange, because a bunch of flags require you to also specify --local. In the end, I did this on the epilogue as a cop-out.
    • paste a screenshot below of what this looks like
  • add a changeset
screenshots of things that don't look quite right

Some of these are things that I saw when comparing https://developers.cloudflare.com/d1/wrangler-commands against the preview output of cloudflare/cloudflare-docs#26602 (I didn't manage to

  • The options on Cloudflare Docs renders quite nicely, but the rendered docs don't look that great (not changed in this PR)
Screenshot 2025-11-24 at 14 35 54 Screenshot 2025-11-24 at 14 36 03
  • Link to "wrangler dev". I will probably leave this as not a link.
Screenshot 2025-11-24 at 14 53 43 Screenshot 2025-11-24 at 14 54 15

(delete this one?)
Screenshot 2025-11-24 at 14 55 13

  • I'm not going to tell people where the "Wrangler configuration file" is. Bit of a shame. I should check that I have been consistent.
Screenshot 2025-11-24 at 14 56 44 Screenshot 2025-11-24 at 14 56 48
  • I added For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel/. I need to check how it will render in the docs.
Screenshot 2025-11-24 at 15 04 04
  • more Wrangler configuration file
Screenshot 2025-11-24 at 15 23 05
  • The longer descriptions are not wrapped by the CLI library, so they look a bit naff. Not sure what to do here.
Screenshot 2025-11-24 at 15 31 11
  • the "experimental" tag is not rendered on wrangler d1 insights on Jun's PR. Probably an easy fix.
  • there is a duplicated wrangler d1 insights on Jun's PR. Probably leftover code that just needs to be deleted.

@changeset-bot
Copy link

changeset-bot bot commented Nov 24, 2025

⚠️ No Changeset found

Latest commit: 201ba3f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new
Copy link

pkg-pr-new bot commented Nov 24, 2025

create-cloudflare

npm i https://pkg.pr.new/create-cloudflare@11393

@cloudflare/kv-asset-handler

npm i https://pkg.pr.new/@cloudflare/kv-asset-handler@11393

miniflare

npm i https://pkg.pr.new/miniflare@11393

@cloudflare/pages-shared

npm i https://pkg.pr.new/@cloudflare/pages-shared@11393

@cloudflare/unenv-preset

npm i https://pkg.pr.new/@cloudflare/unenv-preset@11393

@cloudflare/vite-plugin

npm i https://pkg.pr.new/@cloudflare/vite-plugin@11393

@cloudflare/vitest-pool-workers

npm i https://pkg.pr.new/@cloudflare/vitest-pool-workers@11393

@cloudflare/workers-editor-shared

npm i https://pkg.pr.new/@cloudflare/workers-editor-shared@11393

@cloudflare/workers-utils

npm i https://pkg.pr.new/@cloudflare/workers-utils@11393

wrangler

npm i https://pkg.pr.new/wrangler@11393

commit: 201ba3f

@alsuren alsuren changed the title Dlaban/cfsql 1406 wrangler docs CFSQL-1406 update wrangler d1 ... --help output from Cloudflare Docs site Nov 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Untriaged

Development

Successfully merging this pull request may close these issues.

1 participant