[wrangler] Add --json flag to r2 bucket info command #9530

Akshit222 · 2025-06-09T10:53:14Z

What

Adds a --json flag to the wrangler r2 bucket info command, returning the bucket info in clean JSON format.

Why

The current output is not machine-readable.
Adding this flag makes the output usable in scripts and consistent with D1 commands that already support --json.

How

Adds a --json flag to r2 bucket info
Omits verbose output when --json is passed
Suppresses the Wrangler banner when --json is used
Adds a unit test verifying valid JSON output
Linting fixed with pnpm fix
Added a changeset as per contribution guidelines

Test Plan

✅ pnpm exec vitest run packages/wrangler/src/__tests__/r2/bucket.test.ts passed
✅ Manual output verified
✅ Verified that banner is suppressed when --json is passed

Example

With `--json`:

$ wrangler r2 bucket info my-bucket-name --json

{
  "name": "my-bucket-name",
  "created": "2025-06-07T15:55:22.222Z",
  "location": "APAC",
  "default_storage_class": "Standard",
  "object_count": "0",
  "bucket_size": "0 B"
}

Without `--json`:

$ wrangler r2 bucket info my-bucket-name

(⛅️ wrangler 4.18.0)
Bucket Name: my-bucket-name  
Created At: 2025-06-07T15:55:22.222Z  
Location: APAC  
Storage Class: Standard  
Object Count: 0  
Size: 0 B

Tests
- Tests included
- Tests not necessary because:
Public documentation
- Cloudflare docs PR(s): Add --json flag to r2 bucket info command cloudflare-docs#24120
- Documentation not necessary because:
Wrangler V3 Backport
- Wrangler PR:
- Not necessary because: New features are not backported

changeset-bot · 2025-06-09T10:53:18Z

🦋 Changeset detected

Latest commit: 9ec5cf8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
wrangler	Minor
@cloudflare/vite-plugin	Major
@cloudflare/vitest-pool-workers	Patch

Not sure what this means? Click here to learn what changesets are.

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

frankichiro · 2025-06-09T15:33:06Z

Hello. Since I'm who issued #9433, I'm very happy about this. Although it would be very preferable if it was possible to remove the banner line when using --json, otherwise the result needs to be filtered, which was essentially the original problem. This would also make it consistent with how --json works with D1.

Akshit222 · 2025-06-10T07:09:27Z

Thanks so much for the feedback, @frankichiro — totally agree with you.
You're right that having the banner in --json mode defeats the purpose of clean, machine-readable output and makes it inconsistent with other commands like D1.

I'll go ahead and update the PR to suppress the banner when --json is used, so the output is clean and parseable.

Akshit222 · 2025-06-12T06:17:57Z

Made the requested changes to suppress the banner when --json is used. Let me know if there's anything else I should address — happy to iterate further. Thanks again for the guidance!

Akshit222 · 2025-06-18T15:57:51Z

Just wanted to follow up on this! Let me know if there’s anything else needed from my side to move this forward — happy to make any changes if required. Thanks again for your time!

pkg-pr-new · 2025-07-07T13:59:32Z

create-cloudflare

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

@cloudflare/kv-asset-handler

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

miniflare

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

@cloudflare/pages-shared

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

@cloudflare/unenv-preset

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

@cloudflare/vite-plugin

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

@cloudflare/vitest-pool-workers

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

@cloudflare/workers-editor-shared

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

wrangler

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

commit: 9ec5cf8

emily-shen

Hey, thanks so much for the contribution - sorry this was missed for a while, looks like our github automations went wonky and it wasn't added to our queue 😅

Just a couple of small things, but on the whole looks good.

Would you also be able to add a changeset? https://github.com/cloudflare/workers-sdk/blob/main/packages/wrangler/CONTRIBUTING.md#changesets

And if you're up to it, would you also be able to create a PR to the docs to add it to the wrangler command documentation? https://developers.cloudflare.com/workers/wrangler/commands/#r2-bucket-info

Let me know if you have any questions about this :)

packages/wrangler/src/r2/bucket.ts

packages/wrangler/src/__tests__/r2/bucket.test.ts

emily-shen · 2025-07-07T14:06:16Z

also, it looks like you have some linting issues. you can run pnpm fix to fix them up

Akshit222 · 2025-07-09T11:52:21Z

Thanks a lot for the detailed review,
I’ve addressed all feedback:

-Used behaviour: { showBanner: false } instead of editing the banner file
-Added vi.unmock("../wrangler-banner") to ensure the banner isn’t shown during --json output
-Switched to mockConsoleMethods() in tests
-Ran pnpm fix
-Added a changeset

Let me know if i made a mistake anywhere.

Akshit222 · 2025-07-09T11:58:41Z

Just a quick note: I ended up cleaning up the commit history because the original one had some unrelated files accidentally committed. To keep things clean and focused, I created a fresh branch from main, reapplied only the relevant changes, and force-pushed — which unfortunately removed previous commit-level context. But I’ve addressed all the feedback again in this clean version.

Once you’ve had a chance to review this updated commit, I’ll go ahead and create a follow-up PR to update the Wrangler documentation for the r2 bucket info command as well.

Let me know if anything else is needed!

penalosa · 2025-07-14T13:24:33Z

@Akshit222 thanks for this, this is looking pretty good! Would you be able to restore the PR template and fill out the relevant checkboxes, so we can get this merged?

Akshit222 · 2025-07-17T18:06:15Z

Thanks for the feedback! I'll update the PR template and checkboxes shortly.

Akshit222 · 2025-07-21T16:39:27Z

I've updated the PR description with the template and filled out the checkboxes as requested.
Please let me know if there's anything else you'd like me to address!

Also, please let me know if any of the failing checks need action on my side — happy to fix if required.

petebacondarwin

Thanks for this. I expect that there will be a bunch of snapshot failures that need updating now that the help text for these commands will have changed.

pnpm test:ci -F wrangler -- -u

packages/wrangler/src/__tests__/r2/bucket.test.ts

petebacondarwin · 2025-07-23T09:18:15Z

there are a bunch of linting errors which would mostly be solved by simplifying the test as suggested.

packages/wrangler/src/r2/bucket.ts

petebacondarwin · 2025-07-23T09:22:47Z

Please open a draft docs-PR before merging and reference it in the PR description. It can then be reviewed and merged after this had been released.

frankichiro · 2025-07-23T18:16:53Z

Wow, this really required much more work than I imagined it would. Thanks @Akshit222 for seeing it through, I really appreciate your efforts for making this work.

Akshit222 · 2025-07-26T13:51:48Z

Thanks a lot for the thoughtful feedback and guidance
I will make the rest of mentioned changes as asked very soon

Akshit222 · 2025-07-30T19:08:05Z

Thanks for the detailed review! I've made the following changes based on your feedback:

Snapshot concerns: I'm not using Jest snapshots in these tests, so there's no need to update any. The existing test setup avoids snapshot-based output assertions — but let me know if I misunderstood and you were referring to something else.

Mock reset: You were right — we already call vi.resetAllMocks() by default, so that part was redundant. I've cleaned it up.

JSON parse block simplification: Simplified the --json test as suggested. It now directly asserts on the parsed output rather than wrapping the parse in a try-catch.

Linting issues: These were mostly resolved by the above simplification and cleanup — no lint errors now. I checked after running pnpm check:lint.

logger.json() integration: Updated the bucket.ts implementation to use logger.json() for consistency with other commands when the --json flag is used.

I'll send a follow-up PR to add the relevant docs to docs/content/en/r2 as discussed soon.

Let me know if there’s anything else to tweak!

petebacondarwin

Thank you @Akshit222 for bearing with us. Looks good now.

.changeset/happy-streets-leave.md

Co-authored-by: Pete Bacon Darwin <pete@bacondarwin.com>

holopin-bot · 2025-08-02T13:30:04Z

Congratulations @Akshit222, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cmduai1z6006807l5zii5jc3t

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

Akshit222 requested a review from a team as a code owner June 9, 2025 10:53

workers-devprod added this to workers-sdk Jul 7, 2025

github-project-automation bot moved this to Untriaged in workers-sdk Jul 7, 2025

emily-shen reviewed Jul 7, 2025

View reviewed changes

packages/wrangler/src/r2/bucket.ts Outdated Show resolved Hide resolved

packages/wrangler/src/__tests__/r2/bucket.test.ts Outdated Show resolved Hide resolved

packages/wrangler/src/__tests__/r2/bucket.test.ts Outdated Show resolved Hide resolved

Akshit222 force-pushed the wrangler-r2-info-json branch 2 times, most recently from 4cc8e51 to c7ddab9 Compare July 9, 2025 11:44

petebacondarwin force-pushed the wrangler-r2-info-json branch from c7ddab9 to 1dec4af Compare July 23, 2025 09:02

petebacondarwin reviewed Jul 23, 2025

View reviewed changes

packages/wrangler/src/__tests__/r2/bucket.test.ts Show resolved Hide resolved

packages/wrangler/src/__tests__/r2/bucket.test.ts Outdated Show resolved Hide resolved

petebacondarwin reviewed Jul 23, 2025

View reviewed changes

packages/wrangler/src/r2/bucket.ts Outdated Show resolved Hide resolved

petebacondarwin approved these changes Aug 1, 2025

View reviewed changes

.changeset/happy-streets-leave.md Outdated Show resolved Hide resolved

github-project-automation bot moved this from Untriaged to Approved in workers-sdk Aug 1, 2025

petebacondarwin self-assigned this Aug 1, 2025

Clean commit: Add --json flag to r2 bucket info

5ea58a2

Akshit222 and others added 4 commits August 1, 2025 12:43

Update packages/wrangler/src/r2/bucket.ts

bb2e74a

Co-authored-by: Pete Bacon Darwin <pete@bacondarwin.com>

test: simplify R2 bucket --json test per review suggestion

323a1ea

Update .changeset/happy-streets-leave.md

ea83be3

fix formatting

da1b52a

petebacondarwin force-pushed the wrangler-r2-info-json branch from 5c81d4d to da1b52a Compare August 1, 2025 12:02

petebacondarwin mentioned this pull request Aug 1, 2025

Add --json flag to r2 bucket info command cloudflare/cloudflare-docs#24120

Open

3 tasks

skip remote unenv-preset tests on forks

9ec5cf8

petebacondarwin merged commit e82aa19 into cloudflare:main Aug 2, 2025
70 of 74 checks passed

github-project-automation bot moved this from Approved to Done in workers-sdk Aug 2, 2025

workers-devprod added the contribution [Holopin] Recognizes an open-source contribution, big or small label Aug 2, 2025

workers-devprod mentioned this pull request Aug 1, 2025

Version Packages #10156

Merged

[wrangler] Add --json flag to r2 bucket info command #9530

[wrangler] Add --json flag to r2 bucket info command #9530

Conversation

Akshit222 commented Jun 9, 2025 • edited by petebacondarwin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Why

How

Test Plan

Example

With --json:

Without --json:

Uh oh!

changeset-bot bot commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

frankichiro commented Jun 9, 2025

Uh oh!

Akshit222 commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Akshit222 commented Jun 12, 2025

Uh oh!

Akshit222 commented Jun 18, 2025

Uh oh!

pkg-pr-new bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

emily-shen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emily-shen commented Jul 7, 2025

Uh oh!

Akshit222 commented Jul 9, 2025

Uh oh!

Akshit222 commented Jul 9, 2025

Uh oh!

penalosa commented Jul 14, 2025

Uh oh!

Akshit222 commented Jul 17, 2025

Uh oh!

Akshit222 commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

petebacondarwin left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

petebacondarwin commented Jul 23, 2025

Uh oh!

Uh oh!

petebacondarwin commented Jul 23, 2025

Uh oh!

frankichiro commented Jul 23, 2025

Uh oh!

Akshit222 commented Jul 26, 2025

Uh oh!

Akshit222 commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

petebacondarwin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

holopin-bot bot commented Aug 2, 2025

Uh oh!

Uh oh!

Akshit222 commented Jun 9, 2025 •

edited by petebacondarwin

Loading

With `--json`:

Without `--json`:

changeset-bot bot commented Jun 9, 2025 •

edited

Loading

Akshit222 commented Jun 10, 2025 •

edited

Loading

pkg-pr-new bot commented Jul 7, 2025 •

edited

Loading

Akshit222 commented Jul 21, 2025 •

edited

Loading

petebacondarwin left a comment •

edited

Loading

Akshit222 commented Jul 30, 2025 •

edited

Loading