Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tovuk.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Requirements

  • A GitHub or Google login
  • A Rust backend with a committed Cargo.lock
  • A server that reads the PORT environment variable

​
Create the project contract

From your backend directory: 
npx tovuk init
This creates tovuk.toml. For a new project, start from a template: 
npx tovuk init my-app --template fullstack-rust-tanstack
cd my-app/web && bun install && cd ..

​
Check locally

npx tovuk doctor --json
Fix the first failed check before deploying. Tovuk errors include agent_instruction, so agents can make the exact code change and rerun doctor. Preview locally: 
npx tovuk preview

​
Deploy

npx tovuk deploy --wait --json
On first deploy, the CLI opens browser login for GitHub or Google, stores the Tovuk session, then continues automatically. Tovuk builds the backend, verifies health, and returns the deployment URL. If the build fails, inspect the build logs: 
npx tovuk logs --build <build_id> --json
Fix the first actionable error, rerun doctor, then redeploy.

​
Fullstack repos

Put one tovuk.toml in the repo root, with [backend] and [frontend] sections. Run one command from the repo root: 
npx tovuk deploy --database
Tovuk builds both roots, requests managed Postgres for the Rust backend, serves the frontend at /, and routes /api/* to the backend on the same app URL.
Last modified on May 29, 2026