[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

Fixes #9433 — The current output is not machine-readable. Adding this 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
Adds a unit test verifying valid JSON output

Test Plan

✅ pnpm exec vitest run packages/wrangler/src/__tests__/r2/bucket.test.ts passed
✅ Manual output verified

Notes

Currently, the banner line (⛅ wrangler 4.18.0) still appears even when using --json.
I left it in earlier to avoid blocking the main feature, but it has now been suppressed when --json is passed for cleaner machine-readable output.

Example

With `--json`:

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

(⛅️ wrangler 4.18.0\n──────────────────)
{
  "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\n──────────────────)
Bucket Name: my-bucket-name  
Created At: 2025-06-07T15:55:22.222Z  
Location: APAC  
Storage Class: Standard  
Object Count: 0  
Size: 0 B

Edit (June 12, 2025)

Implemented the requested change to suppress the banner (⛅ wrangler 4.18.0) when --json is used.

$ wrangler r2 bucket info my-bucket-name

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

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

🦋 Changeset detected

Latest commit: 4cc8e51

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

This PR includes changesets to release 2 packages

Name	Type
wrangler	Patch
@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: 1064cfc

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 :)

emily-shen · 2025-07-07T13:59:07Z

packages/wrangler/src/r2/bucket.ts

+      type: "boolean",
+      default: false,
+    },
+  },


you can hide the banner like this:

workers-sdk/packages/wrangler/src/d1/list.ts

Line 14 in 395f36d

behaviour: {

instead of directly modifying wrangler-banner.ts

Thanks for the feedback , I’ve now reverted teh changes to wrangler-banner.ts. Instead, I’m using the behaviour: { showBanner: false } option inside the relevant CLI command for the --json path, similar to how it's done in d1/list.ts.

emily-shen · 2025-07-07T14:01:11Z

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

+import { requireAuth } from "../../user";
+import { getR2Bucket, getR2BucketMetrics } from "../../r2/helpers";
+
+// Mock the dependencies


can you add vi.unmock("../wrangler-banner"); to test the banner isn't included? we mock it out by default in tests

I've added vi.unmock("../wrangler-banner") to ensure we’re explicitly testing that the banner isn’t printed when using --json.

emily-shen · 2025-07-07T14:02:12Z

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

+  it("should output valid JSON format when --json flag is used", async () => {
+    let capturedOutput = "";
+
+    const originalConsoleLog = console.log;


you should use the mockConsoleMethods() helper here

Updated! I’m now using mockConsoleMethods() in the test instead of manually mocking console.log

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!

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

Akshit222 force-pushed the wrangler-r2-info-json branch from 1064cfc to 4cc8e51 Compare July 9, 2025 10:36

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

c7ddab9

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

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

Are you sure you want to change the base?

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

Conversation

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

Uh oh!

What

Why

How

Test Plan

Notes

Example

With --json:

Without --json:

Edit (June 12, 2025)

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

Uh oh!

emily-shen left a comment

Choose a reason for hiding this comment

Uh oh!

emily-shen Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Akshit222 Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

emily-shen Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Akshit222 Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

emily-shen Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Akshit222 Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

emily-shen commented Jul 7, 2025

Uh oh!

Akshit222 commented Jul 9, 2025

Uh oh!

Akshit222 commented Jul 9, 2025

Uh oh!

Uh oh!

Akshit222 commented Jun 9, 2025 •

edited

Loading

With `--json`:

changeset-bot bot commented Jun 9, 2025 •

edited

Loading

Akshit222 commented Jun 10, 2025 •

edited

Loading