---
title: Documentation
description: "Find the Tako task, primitive, or reference you need: agent setup, local development, deployments, secrets, storage, live data, and operations."
---

## Search

Page index: https://tako.sh/llms.txt. Docs and blog posts also have .md URLs.

This site has a search endpoint: https://context7.com/api/v2/ask?siteKey=ask_b8918f0414955bb91bfa1a89&query=<URL-encoded question>. It returns documentation that answers the question, with a source link for each part. No API key is needed. If nothing matches, it says so.


Tako runs applications on local HTTPS and deploys them to your own servers. Use this index to select the relevant topic instead of loading the entire documentation set.

## Read with an agent

Read the project's `AGENTS.md` and selected `tako.toml` first. With Tako MCP connected, use `tako_docs` to list topics or read `docs/<topic>`, and `tako_search_docs` for literal text search. Bundled docs match the installed CLI; use its tool schemas or `tako <command> --help` for exact arguments.

On the web, use [llms.txt](/docs/llms.txt) to discover topics and the `.md` version of a page for source text, for example [secrets.md](/docs/secrets.md). The [JSON API](/docs/openapi.json) lists and retrieves pages. Use the matching [SDK skill](https://tako.sh/skills.md) for JavaScript, Go, or Rust APIs.

## Start here

- [Quickstart](/docs/quickstart/): install, initialize, run locally, and deploy.
- [Coding agents](/docs/agents/): install skills, connect MCP, and use version-matched docs.
- [Framework guides](/docs/framework-guides/): Next.js, TanStack Start, Vite, fetch handlers, Go HTTP frameworks, and Rust/Axum.
- [Docker](/docs/docker/): package an SDK-aware image and deploy it with Tako.

## Develop an app

- [Local development](/docs/development/): start and inspect apps, use HTTPS routes, and run one-off scripts.
- [Secrets](/docs/secrets/): set app secrets, access them through an SDK, and rotate deployed values.
- [Storage](/docs/storage/): bind local or S3-compatible files and issue upload/download URLs.
- [Images](/docs/images/): optimize public images and generate responsive image URLs.
- [Cache](/docs/cache/): cache server-side JSON results with a TTL.

## Add live data and background work

| Need                                  | Primitive                | Important boundary                                                                      |
| ------------------------------------- | ------------------------ | --------------------------------------------------------------------------------------- |
| Deliver events to every subscriber    | [Channels](/docs/channels/)   | Params do not partition a channel's stream; replay is temporary.                        |
| Track online connections and metadata | [Presence](/docs/presence/)   | Membership is scoped by params; metadata does not establish identity.                   |
| Keep database reads current in the UI | [Stores](/docs/stores/)       | Invalidate after committed writes; Tako does not detect database changes automatically. |
| Execute background jobs or schedules  | [Workflows](/docs/workflows/) | Checkpointed side effects still need idempotency.                                       |

Channels, Presence, and Stores require the `postgres_url` provider credential across multiple servers. Workflows support shared Postgres or intentional per-server execution; each primitive documents its requirements. Application databases, file storage, and caches are separate from this runtime state.

## Deploy and operate

- [Servers](/docs/servers/): provision a host, enroll management access, and maintain the service.
- [Deployment](/docs/deployment/): build artifacts, run migrations, and roll a release into traffic.
- [Routing and TLS](/docs/routing/): configure domains, path routes, certificates, and client-IP policy.
- [Operations](/docs/operations/): inspect status and logs, scale instances, and roll back releases.
- [Backups](/docs/backups/): configure private backup storage, create backups, and restore app data.
- [Troubleshooting](/docs/troubleshooting/): choose diagnostics from the observed failure.

## Look something up

- [CLI](/docs/cli/): every command and flag.
- [tako.toml](/docs/tako-toml/): project configuration.
- [Presets](/docs/presets/): runtime and framework defaults.

## Learn the model

[How Tako works](/docs/how-tako-works/) explains the CLI, server, SDK bootstrap, request routing, and state ownership. Use it when a task depends on a runtime boundary; command, configuration, and primitive topics contain the actionable details.

For product context, see [tako.sh](https://tako.sh). Report bugs or request features in [GitHub issues](https://github.com/tako-sh/tako/issues).