# wabe Disk

> Use project-scoped disks and route requests to named actor instances on wabe Cloud.

## Docs

- [Authentication](https://docs.wabe.sh/authentication.md): Use a project API key to access disks on wabe Cloud.
- [wabe Disk documentation](https://docs.wabe.sh/index.md): Use files, SQLite databases, application state and streaming execution through wabe Disk.
- [Quickstart](https://docs.wabe.sh/quickstart.md): Write a file, run a command and store application state through HTTP.

## Actors

- [Actor transport protocol](https://docs.wabe.sh/cloud/actor-protocol.md): Implement the wabecloud.actor.v1 WebSocket transport for a registered HTTPS endpoint.
- [Actor quickstart](https://docs.wabe.sh/cloud/actor-quickstart.md): Register an HTTPS actor endpoint and call a named instance.
- [Actor API](https://docs.wabe.sh/cloud/actors.md): Register a public HTTPS endpoint and call named actor instances over HTTP, SSE or WebSocket.

## Examples

- [Write an HTTP execution client](https://docs.wabe.sh/examples/http-client.md): Stream NDJSON, decode output bytes and require a successful exit record.
- [Store job results](https://docs.wabe.sh/examples/job-results.md): Publish a result and completion status atomically in one KV namespace.
- [Share and search notes](https://docs.wabe.sh/examples/shared-notes.md): Create text files on a shared disk and search them from another request.

## Filesystem

- [Filesystem quickstart](https://docs.wabe.sh/filesystem/quickstart.md): Write and read a file on wabe Disk.

## Git

- [Git quickstart](https://docs.wabe.sh/git/quickstart.md): Stage a file and commit it to a wabe Disk branch.

## Guides

- [Persistence and concurrency](https://docs.wabe.sh/guides/durability.md): Understand write acknowledgements, explicit flush and disk eviction.
- [Work with files](https://docs.wabe.sh/guides/files.md): Upload, download, list and remove files on a named disk.
- [Run JavaScript](https://docs.wabe.sh/guides/javascript.md): Execute a function body with access to files, KV namespaces and streams.
- [Store key/value state](https://docs.wabe.sh/guides/key-value.md): Use logical namespaces, typed values, prefix scans and atomic batches.
- [Search and transform files](https://docs.wabe.sh/guides/search.md): Compose search, filtering and text transforms through the shell interface.
- [Read streaming responses](https://docs.wabe.sh/guides/streaming.md): Handle file bytes, NDJSON records and execution exit status.

## Http

- [Configure file storage](https://docs.wabe.sh/http/config.md): Set chunk size, autosave windows and history retention on one disk.
- [List directory entries](https://docs.wabe.sh/http/entries.md): Stream the direct children of one virtual directory.
- [Errors and retries](https://docs.wabe.sh/http/errors.md): Distinguish HTTP rejection, streamed execution failure and uncertain mutations.
- [Evict a disk](https://docs.wabe.sh/http/evict.md): Persist and unload the local instance while retaining stored data.
- [Execute shell or JavaScript](https://docs.wabe.sh/http/exec.md): Select source, stream stdin, and read output and exit records.
- [Read and write files](https://docs.wabe.sh/http/files.md): Read, replace and append file bodies under a disk virtual path.
- [Flush a disk](https://docs.wabe.sh/http/flush.md): Confirm persistence of preceding file and KV mutations.
- [Reclaim obsolete file data](https://docs.wabe.sh/http/gc.md): Collect expired history and unreferenced content while keeping the disk open.
- [Push and pull with Git](https://docs.wabe.sh/http/git.md): Use a wabe Disk disk as a Git remote over HTTP.
- [KV operations](https://docs.wabe.sh/http/kv.md): Typed values, keys, scans and atomic mutations at one namespace endpoint.
- [HTTP API overview](https://docs.wabe.sh/http/overview.md): Routes, request formats, common parameters and API specification.
- [Redis HTTP API](https://docs.wabe.sh/http/redis.md): Run Redis strings, counters, collections and key scans through an Upstash-compatible HTTP interface.
- [SQLite HTTP API](https://docs.wabe.sh/http/sql.md): Run SQL over Hrana JSON v3 against named SQLite databases.
- [Query the experimental Turso engine](https://docs.wabe.sh/http/turso.md): Use the Rust Turso engine through the HTTP JSON v3 interface.
- [Branches and file history](https://docs.wabe.sh/http/versioning.md): Commit a workspace, edit independent branches, pin versions and restore files.

## Redis

- [Redis quickstart](https://docs.wabe.sh/redis/quickstart.md): Set and read a key in a Redis namespace.

## Runtime

- [Command reference](https://docs.wabe.sh/runtime/commands.md): Supported file, text, KV, Redis, SQL and Git commands in the virtual shell.
- [JavaScript filesystem API](https://docs.wabe.sh/runtime/filesystem.md): Read, write, list and remove virtual files inside a wabe Disk invocation.
- [Git commands](https://docs.wabe.sh/runtime/git.md): Stage, commit, compare, merge and rebase independently writable branches.
- [JavaScript KV API](https://docs.wabe.sh/runtime/key-value.md): Namespace methods, typed values, scans and batches inside wabe Disk.
- [Limits](https://docs.wabe.sh/runtime/limits.md): Input sizes, runtime ceilings and operation scope in the standalone server.
- [Upstash Redis SDK](https://docs.wabe.sh/runtime/redis.md): Use @upstash/redis from an external HTTP client or the isolated wabe Disk JavaScript runtime.
- [Shell syntax](https://docs.wabe.sh/runtime/shell.md): Compose supported commands over virtual paths and byte streams.
- [SQL commands](https://docs.wabe.sh/runtime/sql.md): Create a database, execute a SQL script and read streamed JSON results.
- [JavaScript streams and globals](https://docs.wabe.sh/runtime/streams.md): Use stdin, stdout, stderr, shell pipelines and text helpers.

## Self hosting

- [Embedded CLI](https://docs.wabe.sh/self-hosting/cli.md): Run file, shell and JavaScript operations directly against storage.
- [Server configuration](https://docs.wabe.sh/self-hosting/configuration.md): Standalone CLI options and their environment variables.
- [Run wabe Disk](https://docs.wabe.sh/self-hosting/run.md): Build the standalone server and start a local authenticated instance.

## SQLite

- [SQLite quickstart](https://docs.wabe.sh/sqlite/quickstart.md): Create a table, insert a row and query it over HTTP.
- [Turso SDK for SQLite](https://docs.wabe.sh/sqlite/sdk.md): Connect to a named wabe SQLite database from JavaScript.

## API Reference

- [Cloud OpenAPI schema](https://docs.wabe.sh/openapi-cloud.json): Machine-readable schema for api.wabe.sh.
- [Wabe Cloud API](https://docs.wabe.sh/api-reference.md)
- [GET List projects](https://docs.wabe.sh/api-reference/operations/listprojects.md)
- [POST Create a project](https://docs.wabe.sh/api-reference/operations/createproject.md)
- [GET List project API keys](https://docs.wabe.sh/api-reference/operations/listprojectapikeys.md)
- [POST Create a project API key](https://docs.wabe.sh/api-reference/operations/createprojectapikey.md)
- [DELETE Revoke a project API key](https://docs.wabe.sh/api-reference/operations/revokeprojectapikey.md)
- [GET List actor registrations](https://docs.wabe.sh/api-reference/operations/listactors.md)
- [POST Register an actor endpoint](https://docs.wabe.sh/api-reference/operations/registeractor.md)
- [GET Read an actor registration](https://docs.wabe.sh/api-reference/operations/getactor.md)
- [PATCH Update an actor endpoint](https://docs.wabe.sh/api-reference/operations/updateactor.md)
- [DELETE Delete an actor registration](https://docs.wabe.sh/api-reference/operations/deleteactor.md)
- [POST Refresh an actor session](https://docs.wabe.sh/api-reference/operations/refreshactorsession.md)
- [GET public actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorget.md)
- [HEAD public actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorhead.md)
- [POST public actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorpost.md)
- [PUT public actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorput.md)
- [PATCH public actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorpatch.md)
- [DELETE public actor instance](https://docs.wabe.sh/api-reference/operations/fetchactordelete.md)
- [OPTIONS public actor instance](https://docs.wabe.sh/api-reference/operations/fetchactoroptions.md)
- [TRACE public actor instance](https://docs.wabe.sh/api-reference/operations/fetchactortrace.md)
- [GET public actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorgetpath.md)
- [HEAD public actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorheadpath.md)
- [POST public actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorpostpath.md)
- [PUT public actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorputpath.md)
- [PATCH public actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorpatchpath.md)
- [DELETE public actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactordeletepath.md)
- [OPTIONS public actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactoroptionspath.md)
- [TRACE public actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactortracepath.md)
- [GET disk-scoped actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorondiskget.md)
- [HEAD disk-scoped actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorondiskhead.md)
- [POST disk-scoped actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorondiskpost.md)
- [PUT disk-scoped actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorondiskput.md)
- [PATCH disk-scoped actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorondiskpatch.md)
- [DELETE disk-scoped actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorondiskdelete.md)
- [OPTIONS disk-scoped actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorondiskoptions.md)
- [TRACE disk-scoped actor instance](https://docs.wabe.sh/api-reference/operations/fetchactorondisktrace.md)
- [GET disk-scoped actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorondiskgetpath.md)
- [HEAD disk-scoped actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorondiskheadpath.md)
- [POST disk-scoped actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorondiskpostpath.md)
- [PUT disk-scoped actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorondiskputpath.md)
- [PATCH disk-scoped actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorondiskpatchpath.md)
- [DELETE disk-scoped actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorondiskdeletepath.md)
- [OPTIONS disk-scoped actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorondiskoptionspath.md)
- [TRACE disk-scoped actor instance path](https://docs.wabe.sh/api-reference/operations/fetchactorondisktracepath.md)
- [GET List project disks](https://docs.wabe.sh/api-reference/operations/listdisks.md)
- [GET Read a disk](https://docs.wabe.sh/api-reference/operations/getdisk.md)
- [PUT Create a disk](https://docs.wabe.sh/api-reference/operations/createdisk.md)
- [GET Read a file](https://docs.wabe.sh/api-reference/operations/readfile.md)
- [PUT Replace a file](https://docs.wabe.sh/api-reference/operations/writefile.md)
- [POST Append streamed bytes to current EOF](https://docs.wabe.sh/api-reference/operations/appendfile.md)
- [DELETE Remove file or empty directory](https://docs.wabe.sh/api-reference/operations/removefile.md)
- [GET List direct directory children](https://docs.wabe.sh/api-reference/operations/listentries.md)
- [GET Read file storage settings](https://docs.wabe.sh/api-reference/operations/getstorageconfig.md)
- [PATCH Set all file storage settings](https://docs.wabe.sh/api-reference/operations/setstorageconfig.md)
- [GET Read object metadata](https://docs.wabe.sh/api-reference/operations/statfile.md)
- [POST Create directory](https://docs.wabe.sh/api-reference/operations/makedirectory.md)
- [POST Move to exact destination](https://docs.wabe.sh/api-reference/operations/moveentry.md)
- [GET List branches](https://docs.wabe.sh/api-reference/operations/listbranches.md)
- [POST Create independently writable branch](https://docs.wabe.sh/api-reference/operations/createbranch.md)
- [DELETE Delete a nondefault branch](https://docs.wabe.sh/api-reference/operations/deletebranch.md)
- [GET List retained workspace commits](https://docs.wabe.sh/api-reference/operations/listcommits.md)
- [POST Seal selected branch and create a commit](https://docs.wabe.sh/api-reference/operations/createcommit.md)
- [DELETE Delete an unreferenced commit](https://docs.wabe.sh/api-reference/operations/deletecommit.md)
- [GET List file versions newest first](https://docs.wabe.sh/api-reference/operations/filehistory.md)
- [GET Read sealed file version](https://docs.wabe.sh/api-reference/operations/readfileversion.md)
- [POST Restore shared content as a new file state](https://docs.wabe.sh/api-reference/operations/restorefile.md)
- [GET List explicit pins](https://docs.wabe.sh/api-reference/operations/listlabels.md)
- [PUT Pin a file, directory view or commit](https://docs.wabe.sh/api-reference/operations/pinstate.md)
- [DELETE Remove a pin](https://docs.wabe.sh/api-reference/operations/deletelabel.md)
- [GET Read pinned file bytes](https://docs.wabe.sh/api-reference/operations/readfilelabel.md)
- [POST Run a Redis command](https://docs.wabe.sh/api-reference/operations/postrediscommand.md)
- [PUT Run a Redis command](https://docs.wabe.sh/api-reference/operations/putrediscommand.md)
- [GET Run a Redis path command](https://docs.wabe.sh/api-reference/operations/getredispath.md)
- [POST Run a Redis path command](https://docs.wabe.sh/api-reference/operations/postredispath.md)
- [PUT Run a Redis path command](https://docs.wabe.sh/api-reference/operations/putredispath.md)
- [POST Run a Redis pipeline](https://docs.wabe.sh/api-reference/operations/postredispipeline.md)
- [PUT Run a Redis pipeline](https://docs.wabe.sh/api-reference/operations/putredispipeline.md)
- [POST Run a Redis transaction](https://docs.wabe.sh/api-reference/operations/postredistransaction.md)
- [PUT Run a Redis transaction](https://docs.wabe.sh/api-reference/operations/putredistransaction.md)
- [POST Execute a Hrana JSON v3 pipeline](https://docs.wabe.sh/api-reference/operations/hranapipeline.md)
- [POST Execute a Hrana JSON v3 cursor](https://docs.wabe.sh/api-reference/operations/hranacursor.md)
- [GET Git ref advertisement](https://docs.wabe.sh/api-reference/operations/advertisegitrefs.md)
- [POST Fetch objects](https://docs.wabe.sh/api-reference/operations/uploadgitpack.md)
- [POST Push objects](https://docs.wabe.sh/api-reference/operations/receivegitpack.md)
- [POST Execute shell or JavaScript](https://docs.wabe.sh/api-reference/operations/execute.md)
- [POST Operate on a KV namespace](https://docs.wabe.sh/api-reference/operations/keyvalue.md)
- [GET Read retained changes or subscribe](https://docs.wabe.sh/api-reference/operations/readnotifications.md)
- [POST Update notification capture and retention](https://docs.wabe.sh/api-reference/operations/configurenotifications.md)
- [PUT Set the chunk size for future file writes](https://docs.wabe.sh/api-reference/operations/setchunksize.md)
- [GET Check the server](https://docs.wabe.sh/api-reference/operations/health.md)
- [GET Read the Cloud API index](https://docs.wabe.sh/api-reference/operations/readcloudindex.md)

## Optional

- [Full documentation](https://docs.wabe.sh/llms-full.txt): Every page above in one file
- [Cloud HTTP reference](https://api.wabe.sh/llm.txt): Read the HTTP reference served by the Cloud API.