Google Cloud APIs on your laptop. Verified, not assumed.

From zero to your first call

1. 1 Install

   Homebrew

   Homebrew

   brew install cloudburrow/tap/cloudburrowcloudburrow version

   Install script

   Install script

   curl -fsSL https://raw.githubusercontent.com/cloudburrow/cloudburrow/main/scripts/install.sh | sh

   It verifies the SHA-256 checksum and, when gh is installed, the GitHub build attestation. It refuses an archive it cannot verify.

   From source

   From source

   git clone https://github.com/cloudburrow/cloudburrow.gitcd cloudburrowmake build

   A plain go install build has no embedded Storage server, and up refuses it. Use make build.

   Needs Docker (4 CPU / 6 GB), kind v0.33.0 and kubectl. macOS and Linux only; Windows is unsupported and WSL2 is untested. macOS binaries in v0.1.0 are not yet signed or notarized (#605). The console opens at http://127.0.0.1:9090 and is labelled LOCAL.

2. 2 Check

   Terminal

   cloudburrow doctor

   cloudburrow doctor changes nothing, and fails only on what would stop up.

3. 3 Run

   Terminal

   cloudburrow up# in another shelleval "$(cloudburrow env)"

4. 4 Call it

   Python · Cloud Storage

   import uuid
   from google.cloud import storage
   
   client = storage.Client()
   bucket = client.create_bucket(f"example-{uuid.uuid4().hex[:12]}")
   bucket.blob("hello.txt").upload_from_string("hello")
   assert bucket.blob("hello.txt").download_as_text() == "hello"
   bucket.delete(force=True)
   

   This block is run by CloudBurrow's Python suite in CI. If it stops working, CI fails. docs/examples/python.md

   Node.js · Cloud Storage

   import assert from 'node:assert/strict';
   import { randomUUID } from 'node:crypto';
   import { Storage } from '@google-cloud/storage';
   
   const apiEndpoint = process.env.STORAGE_EMULATOR_HOST;
   delete process.env.STORAGE_EMULATOR_HOST;
   const storage = new Storage({ apiEndpoint, projectId: process.env.GOOGLE_CLOUD_PROJECT });
   
   const [bucket] = await storage.createBucket(`example-${randomUUID()}`);
   await bucket.file('hello.txt').save('hello', { resumable: false });
   const [data] = await bucket.file('hello.txt').download();
   assert.equal(data.toString(), 'hello');
   await bucket.deleteFiles({ force: true });
   await bucket.delete();
   

   This block is run by CloudBurrow's Node.js suite in CI. If it stops working, CI fails. docs/examples/node.md

   Go is tested through CloudBurrow's own compatibility suite. Java, .NET, Ruby and PHP are untested.

macOS binaries in v0.1.0 are not signed or notarized (#605). See Gatekeeper in docs/install.md.