AI Agent Setup
One file in your repo. Any AI coding agent can deploy to Telbase without fetching documentation from the internet.
Recommended
npx telbase initCreates TELBASE.md, updates your AI agent configs, and sets up your project — all in one command.
Or manually
TELBASE.md is a deployment reference file you add to your repo root. It contains everything an AI coding agent needs to deploy your app to Telbase — CLI commands, framework routing, database provisioning, error handling, and more. Works with Claude Code, Cursor, GitHub Copilot, Windsurf, and any agent that reads project files.Automatic Setup
The fastest way to set up is telbase init. It handles everything:
Run telbase init
TELBASE.md in your repo root. If you have agent config files (.cursorrules, .windsurfrules, etc.), it automatically adds a reference to TELBASE.md.npx telbase initDeploy
Ask your AI agent to deploy, or run the command directly.
npx telbase deploytelbase init also creates a project-specific deployment section in CLAUDE.md and registers the Telbase MCP server for Claude Code. See Claude Code docs for details.Manual Setup
If you downloaded TELBASE.md manually, you need to tell your AI agent to read it. Add one line to your agent's configuration file:
For the best experience, run npx telbase init — it creates a project-specific deployment section in CLAUDE.md and registers MCP tools.
Or add this line to your CLAUDE.md:
Read TELBASE.md in the repo root for Telbase deployment instructions.For advanced features (MCP tools, /deploy command, AI feedback loop), see Claude Code docs.
What's Inside
TELBASE.md covers deploy commands, framework routing, database provisioning, environment variables, troubleshooting, and pricing — everything an agent needs in ~200 lines:
<!-- AI Agent: This file contains deployment instructions for Telbase (telbase.ai).
Use these commands when the user asks to deploy their application. -->
<!-- telbase-docs v2 — keep in sync with telbase-web/apps/marketing/public/TELBASE.md -->
# Telbase Deployment Guide
Telbase deploys full-stack apps to production with one command. It auto-detects your framework, provisions databases, runs migrations, and deploys — no configuration required. Your app goes live at `https://your-app.telbase.ai`.
## Quick Start
```bash
# Install (or use npx telbase directly — no global install needed)
npm install -g telbase
# Authenticate (opens browser for device auth)
telbase auth login
# Deploy from your project directory
...Next Steps
- Quick Start — deploy your first app
- Claude Code — MCP tools, /deploy command, AI feedback loop
- Supported Frameworks — detection rules and routing
- Databases — auto-provisioning, migrations, pgvector
- Troubleshooting — common errors and fixes