# floo

> floo: where agents ship applications. Agents call the HTTP API, starting from https://getfloo.com/agents.md; the OpenAPI spec at https://api.getfloo.com/openapi.json lists every operation. With the floo CLI installed, it is the version-matched authority: run `floo commands --json`, exact command help, then `floo docs <topic> --json`. Initialize and preflight locally, commit and push, then connect GitHub to create the app and deploy the pushed commit.

## Get started

- [Quickstart](https://getfloo.com/docs/introduction.md): Install floo and get your app live.
- [CLI commands](https://getfloo.com/docs/guides/cli.md): Find the floo command for a task, and the recipes you use after the first deploy.
- [How floo works](https://getfloo.com/docs/how-floo-works.md): The mental model. Config in the repo, GitHub-backed deploys, the CLI or the API for agents, dashboard as window.
- [Glossary](https://getfloo.com/docs/glossary.md): The terms floo uses, defined once.

## Build with your stack

- [Build a Next.js app on floo](https://getfloo.com/docs/build/nextjs.md): End-to-end guide. Deploy a Next.js (App Router) app, add Postgres, add per-user auth, and ship a custom domain.
- [Build a Rails app on floo](https://getfloo.com/docs/build/rails.md): End-to-end guide. Deploy a Rails app, add Postgres, add per-user auth, and ship a custom domain, all from a real Rails project.
- [Build a FastAPI app on floo](https://getfloo.com/docs/build/fastapi.md): End-to-end guide. Deploy a FastAPI app, add Postgres, add per-user auth, and ship a custom domain, all from a real Python project.
- [Build a Django app on floo](https://getfloo.com/docs/build/django.md): End-to-end guide. Deploy a Django app, add Postgres, add per-user auth, and ship a custom domain, all from a real Django project.
- [Build an Express app on floo](https://getfloo.com/docs/build/express.md): End-to-end guide. Deploy an Express (Node.js) app, add Postgres, add per-user auth, and ship a custom domain.

## Deploy

- [Configuring an app](https://getfloo.com/docs/guides/configuration.md): The floo.app.toml patterns you reach for most, from a single service to multi-service with managed credentials.
- [Git as source of truth](https://getfloo.com/docs/guides/config-as-code.md): Keep app shape in git so humans and agents share one source of truth.
- [Multi-service routing](https://getfloo.com/docs/guides/multi-service-routing.md): How floo routes traffic across services in a multi-service app.
- [Cron jobs](https://getfloo.com/docs/guides/cron-jobs.md): Schedule recurring tasks inside your app's containers.
- [Dockerfiles](https://getfloo.com/docs/guides/dockerfiles.md): Dockerfile requirements, the templates floo init writes, and automatic registry caching.

## Managed services

- [Managed services](https://getfloo.com/docs/guides/managed-services.md): What floo runs for you, how each is declared, and the shared lifecycle.
- [Postgres](https://getfloo.com/docs/guides/postgres.md): Declare managed Postgres, consume DATABASE_URL, and use pgvector and preview branches.
- [Redis](https://getfloo.com/docs/guides/redis.md): Declare managed Redis, and use named instances to separate cache from queue.
- [Storage](https://getfloo.com/docs/guides/cloud-storage.md): Store and read files with S3 clients, AI loaders, or the Google storage SDK.

## Environments

- [Environments](https://getfloo.com/docs/guides/environments.md): Every floo app has a dev and production environment. Push to dev, promote to production.
- [Preview environments](https://getfloo.com/docs/guides/preview-environments.md): Create pull request previews and command-line preview sandboxes with isolated managed services and preview database branches.
- [Environment variables](https://getfloo.com/docs/guides/environment-variables.md): Set, inspect, import, and scope env vars with the shipped floo CLI.
- [Releases and rollbacks](https://getfloo.com/docs/guides/rollbacks.md): Promote named releases when things are good, and roll back to a prior deploy when they are not.

## Operate

- [Logs and debugging](https://getfloo.com/docs/guides/logs.md): Use runtime logs, build logs, and deploy watch together to debug shipped apps.
- [Analytics and alerts](https://getfloo.com/docs/guides/analytics-alerts.md): Use traffic analytics and alert rules to understand app behavior after deploys and catch problems earlier.
- [Agent webhooks](https://getfloo.com/docs/guides/agent-webhooks.md): When a deploy fails or a runtime error fires repeatedly, floo packages the context and POSTs an event to your agent or workflow.
- [Scaling and availability](https://getfloo.com/docs/guides/scaling.md): Choose an on-demand, warm, fixed, or paused runtime posture in floo.app.toml.
- [Billing and spend caps](https://getfloo.com/docs/guides/budget-controls.md): Inspect plan usage, set a spend cap, choose what happens at the cap, and know when deploys will be blocked.

## Access

- [Auth](https://getfloo.com/docs/guides/app-auth.md): Set access_mode = "accounts" and your app gets a hosted sign-in flow, identity headers on every request, and a per-app user list, without writing any auth code.
- [App API keys and request history](https://getfloo.com/docs/guides/app-api-keys.md): Give a program access to selected app routes, inspect its requests, and revoke its key.
- [Team and access control](https://getfloo.com/docs/guides/team-access.md): Manage org members, app access modes, and end-user access.
- [Custom domains](https://getfloo.com/docs/guides/custom-domains.md): Declare a custom domain in floo.app.toml, release to prod, and publish two DNS records.
- [Networking and egress](https://getfloo.com/docs/guides/networking.md): Understand inbound routing, outbound internet egress, and the private-network deployment model.

## For agents

- [Agent setup](https://getfloo.com/docs/guides/agent-setup.md): Set up an agent to deploy, operate, and debug floo apps through the CLI or the HTTP API.
- [Dashboard vs CLI](https://getfloo.com/docs/guides/dashboard-vs-cli.md): Understand which surfaces are the control plane, which is the window, and why the split matters.

## CLI reference

- [CLI overview](https://getfloo.com/docs/cli/overview.md): Output modes, app inference, preflight, and the quickest way to find the right floo command.
- [init](https://getfloo.com/docs/cli/init.md): CLI reference: floo init, initialize a new floo project
- [preflight](https://getfloo.com/docs/cli/preflight.md): CLI reference: floo preflight, validate project config and check deploy readiness
- [deploys](https://getfloo.com/docs/cli/deploys.md): CLI reference: floo deploys - view and manage deploy history
- [redeploy](https://getfloo.com/docs/cli/redeploy.md): CLI reference: floo redeploy, force a redeploy after env var changes or config updates
- [dev](https://getfloo.com/docs/cli/dev.md): CLI reference: floo dev, run all services locally with managed service credentials
- [run](https://getfloo.com/docs/cli/run.md): CLI reference: floo run, execute a one-shot command with a service's managed env vars injected
- [apps](https://getfloo.com/docs/cli/apps.md): CLI reference: manage apps, explicit app invitations and members, and GitHub connections
- [github](https://getfloo.com/docs/cli/github.md): CLI reference: floo apps github, manage GitHub integration for auto-deploy
- [projects](https://getfloo.com/docs/cli/projects.md): CLI reference: floo projects, create, list, and clone managed apps without a GitHub account
- [env](https://getfloo.com/docs/cli/env.md): CLI reference: floo env set, floo env get, floo env list, floo env unset, floo env import
- [services](https://getfloo.com/docs/cli/services.md): CLI reference: floo services, provision, inspect, and remove managed services on a floo app
- [storage](https://getfloo.com/docs/cli/storage.md): CLI reference: list, measure, delete, and restore floo Storage objects
- [db](https://getfloo.com/docs/cli/database.md): Query and inspect managed Postgres surfaces for an app.
- [logs](https://getfloo.com/docs/cli/logs.md): CLI reference: floo logs, view runtime logs
- [events](https://getfloo.com/docs/cli/events.md): CLI reference: list the agent events floo recorded for an app
- [releases](https://getfloo.com/docs/cli/releases.md): CLI reference: floo releases, manage releases and promote apps to production
- [previews](https://getfloo.com/docs/cli/previews.md): Create, inspect, stream logs for, and delete preview sandboxes from remote GitHub branches.
- [cron](https://getfloo.com/docs/cli/cron.md): CLI reference: floo cron, list, show, and manually trigger scheduled cron jobs. Schedules are declared in floo.app.toml, not added by the CLI.
- [domains](https://getfloo.com/docs/cli/domains.md): CLI reference: floo domains list, show, watch
- [edge](https://getfloo.com/docs/cli/edge.md): CLI reference: inspect the effective edge route table and IP policy for an app
- [doctor](https://getfloo.com/docs/cli/doctor.md): CLI reference: floo doctor reports failed managed-service provisions and accounts-mode drift
- [auth](https://getfloo.com/docs/cli/auth.md): CLI reference: floo auth, authenticate and manage your account
- [orgs](https://getfloo.com/docs/cli/orgs.md): CLI reference: floo orgs, manage organization members, invitations, SSO, and the active org
- [billing](https://getfloo.com/docs/cli/billing.md): CLI reference: prepaid balance, funding, usage, and spend caps
- [analytics](https://getfloo.com/docs/cli/analytics.md): CLI reference: floo analytics, view traffic analytics for an app or org
- [notifications](https://getfloo.com/docs/cli/notifications.md): CLI reference: floo notifications list and set email preferences
- [skills](https://getfloo.com/docs/cli/skills.md): CLI reference for installing the floo documentation skill
- [feedback](https://getfloo.com/docs/cli/feedback.md): CLI reference: send product feedback, bug reports, and feature requests to floo
- [commands and docs](https://getfloo.com/docs/cli/discovery.md): CLI reference: floo commands and floo docs, the machine-readable command tree and topic index.
- [update](https://getfloo.com/docs/cli/update.md): Check for floo updates, print the installed version, or update the CLI in place.

## Config

- [Container contract](https://getfloo.com/docs/reference/container-contract.md): What floo requires of any image, whether you write the Dockerfile or your agent does.
- [Config file spec](https://getfloo.com/docs/reference/config-spec.md): All floo config fields, file shapes, and precedence rules.
- [Error codes](https://getfloo.com/docs/reference/error-codes.md): The floo CLI and API error codes you act on, with descriptions and fixes.
- [Build context](https://getfloo.com/docs/reference/build-context.md): Which files reach a floo build, and how to keep large or sensitive files out of it.