taubyte-reference-docs
Taubyte reference documentation
This skill bundles the Taubyte command and logic markdown references, SDK operation guides, and debugging notes as plain files under references/.
How to use
- For CLI flags on a resource, open the matching
*-commands.md(e.g.function-commands.md,database-commands.md). - For behavior and architecture, open the matching
*-logic.md. - For Go SDK usage, start with
sdk-api-must.md, thensdk-function-http.md,sdk-operation-database.md,sdk-operation-storage.md, etc. - For Dream/local workflows, use
dream-*anddream-env-commands.md/dream-env-logic.mdas needed. - For websites build output, see
taubyte-folder-examples.md.
Key entry points
| Topic | Files |
|---|---|
| Project / clone / push | project-commands.md, project-logic.md, repo-commands.md, repo-logic.md |
| Functions / HTTP | function-commands.md, function-logic.md, sdk-function-http.md, sdk-function-pubsub.md |
| Databases / storage | database-commands.md, database-logic.md, storage-commands.md, storage-logic.md, sdk-operation-database.md, sdk-operation-storage.md |
More from taubyte/skills
verifying-taubyte-functions
Verifies a Taubyte Go function locally via the `taubyte/go-wasi` Docker recipe (preferred over `tau build`, with tmpfs+bind-mount-ro to avoid root-owned artifacts in the source tree), and verifies a function actually serves on Dream by curling the gateway with the right `Host:` header (plus `/etc/hosts` mapping for `*.localtau`). Use when locally compiling a Go function to WASM, when smoke-testing a function before pushing, or when probing a Dream-hosted HTTP function from the laptop.
13creating-taubyte-resources
Creates Taubyte resources non-interactively via `tau new` for domain, website, library, function, application, database, storage, messaging, and service. Encodes the project-vs-application scope rule, the database `min < max` constraint, the website/library `--generate-repository` + import sequence, and the forbidden `--generated-fqdn-prefix` flag. Use when adding any resource to a Taubyte project's config repo.
13diagnosing-dream-builds
Diagnoses Dream local-cloud builds when `tau list/query builds` is empty or unreliable, by hitting the jobs HTTP endpoint directly (`GET /jobs/<project_id>`, `GET /job/<job_id>`) using the GitHub token from `~/tau.yaml`, then downloading logs with `tau query logs --jid`. Use when Dream builds appear silent, the build table is empty after `dream inject`, or you need raw job ids and logs for a failing build.
12installing-taubyte-tooling
Installs and verifies the prerequisites for any Taubyte workflow — Node.js, Docker (engine + running daemon), `@taubyte/cli` (the `tau` command), and `@taubyte/dream` (the `dream` command). Acts as a hard gate that runs before every other Taubyte skill, with OS-specific automated installs (winget / brew / apt-get) and explicit stop conditions when an install fails. Use on first-time machine setup, when `tau` or `dream` is missing or broken, when `docker info` fails, or when starting a fresh shell and you don't know if the toolchain is ready.
12pushing-taubyte-projects
Pushes Taubyte project changes via `tau push` — `tau push project [--config-only|--code-only]`, `tau push website <name>`, and `tau push library <name>` — with the rule that `--message` is required when `--defaults` is set, and the push-config-before-code ordering for resource-dependent changes. Also explains the `tau pull` "already up-to-date" non-zero-exit quirk. Use when pushing local changes to GitHub through `tau` (instead of raw `git push`), or when triggering remote-cloud webhooks / Dream injects after edits.
12starting-dream-locally
Starts a Dream local Taubyte cloud (multiverse) using either the newer `dream start` workflow or the older `dream new multiverse` workflow, and explains the default universe naming (`default` for `dream start`, `blackhole` for `dream new multiverse`). Use when bringing up, restarting, or daemonizing a local Dream cloud, or when `dream --help` shows a different shape than expected.
12