The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Revdoku listing page.
Cloud storage with an email address for every bucket. Store documents, data, and project files; receive email and attachments in the same bucket; share files with authorized people and AI agents. Files and incoming messages stay private within your account access permissions.
Use the CLI for local files, hosted MCP for AI agents, or the REST API for your own integrations. Buckets keep version history so you can review changes and restore earlier files.
Use revdoku upload ./project-files to save a local folder privately. Read files, inspect history, and
restore earlier versions through the CLI, MCP, API, or dashboard. All stored files
can be downloaded from Revdoku at any time.
Share the bucket's dashboard link with people who have account access. Authorize each AI connection separately for the intended buckets. A dashboard link does not grant access by itself. Agents can work on the same files with locks and revision checks to coordinate changes.
See the storage quick start, file sharing, and multiple-agent example.
Each bucket has its own incoming email address. Bucket creation returns the
address and receiving state; for an existing bucket, use
bucket_get(include_inbound_email: true) with write access or Bucket settings →
Email. Check inbound_email.ready before using the address.
With the CLI, run revdoku inbox --bucket-id bkt_... to retrieve the address,
readiness, and activity. Use revdoku read PATH --bucket-id bkt_... for stored mail.
Receive invoices, documents, project updates, or authorized service verification
messages. Each accepted email is saved as original message.eml, decoded
message.json, readable message.md, and attachment files. Authorized people and agents can read these
with the same file tools used for other bucket content.
Compare inbound_email.received_count to detect new mail, then read
last_received_path + "message.json" for the body and attachment paths. Anyone
knowing the address can email the bucket; reading its contents requires access.
See incoming email
and the API contract.
Create an account at https://app.revdoku.com/users/sign_up and connect in the browser. Never paste account credentials or verification codes into AI chat. You can start free. See pricing for current plans.
Private storage and collaboration follow the Terms of Use.
Contact support@revdoku.com for account, billing, or access questions.
The installer supports codex, claude-code, cursor, antigravity,
opencode, grok-build, hermes, openclaw, and all through the
REVDOKU_AGENT environment variable. Automatic setup installs for Codex and
any other detected clients.
Install the public skill and CLI:
To target one agent, add --agent codex (or claude-code, cursor, etc.).
This also avoids the upstream PromptScript global-install error.
Hermes can install the complete skill directly:
To subscribe to this repository as a Hermes source, use
hermes skills tap add revdoku/revdoku.
Claude Code users can run /plugin marketplace add revdoku/revdoku, then
/plugin install revdoku@revdoku. Codex users can add the repository with
codex plugin marketplace add revdoku/revdoku and select Revdoku in the plugin browser.
Gemini CLI users can run gemini extensions install https://github.com/revdoku/revdoku.
The Revdoku-owned skill and bundled CLI may also be used under MIT-0; see the
skill's LICENSE. The repository's default license remains MIT. Third-party
dependencies retain their own licenses.
If npm is unavailable:
The skill runs its bundled CLI. The shell installer verifies the CLI and skill files against embedded SHA-256 hashes before installation. If verification fails, fetch the current installer and retry. Download-source overrides are unsupported.
npx skills installs the CLI inside the skill, without adding revdoku to
your shell PATH. Agents use the bundled scripts/revdoku.sh with the same
arguments as the commands below.
Store or update a local folder:
The first run opens browser sign-in when credentials are missing. Re-running updates the same bucket. New accounts can be created on the web signup page.
Useful commands:
revdoku upload [PATH] — store or update private files.revdoku files, revdoku read PATH — list and read stored files and email.revdoku inbox --bucket-id ID — check the incoming address and receiving state.revdoku versions, revdoku restore ID — inspect and restore history.revdoku status, revdoku ls — inspect the connection and buckets.revdoku dashboard, revdoku --help — open the dashboard or command reference.The hosted MCP endpoint is https://app.revdoku.com/mcp. All tools use OAuth.
If the user has no Revdoku account, direct them to browser signup before using
account tools.
Hosted agents cannot read files from the user's computer. Use the local Revdoku CLI for local folders, JavaScript bundles, images, fonts, PDFs, and other binary assets. MCP can directly write generated text files.
Per AI client guides:
Use those tutorials when manual setup or troubleshooting is needed. Follow the user's file storage, sharing, or incoming-email goal.
This repository contains the Revdoku CLI, skill, API documentation, and
Claude/Codex/Cursor plugin manifests. The hosted MCP implementation runs at
https://app.revdoku.com/mcp. MCP manifests use OAuth, and every tool descriptor requires OAuth.
See CHANGELOG.md, api.md, and the MCP mailbox guide.
Run revdoku status to see the credential's default account and authorized
accounts. Each identity includes account_kind (standard, agency, or client),
the separate client_name, and agency_account when the parent is granted.
kind remains a compatibility alias. Use --account-id ID on each command to target a client; omitting it
always uses the credential's main account. The Agency owner must explicitly
include client accounts when connecting or in Account → Access.
An agency and its clients share account capacity. Each client keeps separate
files, members, and branding.
Account names and client names can differ. Unknown client names stay unset.
revdoku account --account-id ID shows a client’s identity and provider guidance;
client billing data remains restricted to the agency owner. Browser switching
does not change the CLI credential’s default account.
Check custom-domain availability in Account Settings. Setup lives in Account
Settings → Domains → Email and requires an account administrator. Prefer an unused
receiving subdomain; dedicated root domains are accepted. DNS changes require the
user's authorization. Connecting a domain does not change existing bucket addresses.
Use only the full address returned by Revdoku and check ready. A domain switch
may return assignment.status: pending; poll until active or failed, keeping the
current address in use meanwhile. Never construct aliases or use +tag variants.
See the email API contract.