Documentation

TinyCld serves two audiences and the docs are split to match.

Operate

You want to run TinyCld for your team — set up a server, get a domain, manage users, back up your data.

• Install TinyCld — clone, boot, and run the first-time setup wizard.

Build

You want to write a package for TinyCld, or contribute to one of the existing ones. Packages are sibling git repos that link into the app shell.

• Getting started — the layout of the ecosystem, how the app shell and feature siblings relate, and how a fresh clone runs without any packages.
• Adding a package — install an existing package into the app shell with npm run packages:install or packages:link.
• Creating a package — scaffold a new package from scratch with npx @tinycld/create-package.
• Anatomy of a package — every directory, manifest field, and file a package can contain.
• Tasks — how to do common things inside a package: query data, mutate, build forms, manage UI state.
• Internals and reference — the generator, Go server wiring, and exhaustive field/CLI tables.

Start here →