Skip to content

bloom-directory/docs

Repository files navigation

Bloom

Bloom Docs

User-facing documentation for Bloom, the agentic Ethereum wallet mounted as a virtual filesystem.

CI Live docs Bloom website

Read the docs · Quickstart · Use cases · Agent setup skill

Bloom turns Ethereum into a directory your agent can inspect and write to with ordinary filesystem tools. Reads are onchain queries, writes are staged wallet intents, and every meaningful action leaves reviewable files behind.

If you are here to use Bloom, start with the live docs. The docs cover setup, the mounted /bloom filesystem, wallet transaction review, policy controls, and power-user workflows that combine chain reads, encoding helpers, simulations, watches, and transaction staging.

What you can do with Bloom

  • Ask agents to query chain state without writing custom Web3 SDK glue.
  • Read balances, blocks, gas, contract ABIs, method calls, events, ENS records, prices, and daemon status as files.
  • Stage wallet actions by writing plain-language or structured intents, then inspect plan.md before confirmation.
  • Pipe Bloom files through standard shell tools like jq, awk, xargs, comm, and sort.
  • Use /bloom/tools/ helpers for selectors, ABI/RLP/EIP-712 encoding, unit conversion, hashing, checksums, hex, and base64.
  • Keep private keys out of the filesystem while still giving agents a safe, auditable operating surface.

Bloom is experimental, unaudited alpha software. Treat docs examples as workflows to adapt and review, not as production financial advice. Never use funds you cannot afford to lose.

Useful links

Local development

This repository is the Vocs-powered documentation site for Bloom, configured for Cloudflare Pages.

npm install
npm run dev

Open the local URL printed by Vocs.

Production build

npm ci
npm run build
npm run preview

npm run build writes the static site to dist/public.

Cloudflare Pages deployment

Use the existing Cloudflare Pages project for this repo.

Recommended Pages settings:

  • Framework preset: None / custom
  • Root directory: repository root
  • Build command: npm ci && npm run build
  • Build output directory: dist/public
  • Node version: 22, or Cloudflare Pages' current LTS if 22 is unavailable

Pages will create preview deployments automatically for pull requests when the Pages project is connected to the GitHub repo and preview deployments are enabled.

Content sources

The docs are seeded from:

Do not copy secrets, private keys, RPC credentials, or unpublished operational details into this public docs site.

About

Vocs and Cloudflare Pages powered docs for /bloom

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors