Skip to main content

​
Requirements

  • Python 3.11+
  • Docker & Docker Compose (to run generated projects)

​
Install

pip install backant-cli
Use a virtual environment to keep your global Python environment clean.

​
Verify

ant --help
Expected output: 
Usage: ant [OPTIONS] COMMAND [ARGS]...

Options:
  --report  Output machine-readable JSON instead of human-readable text.
  --help    Show this message and exit.

Commands:
  generate  Generate API projects, routes, and subroutes.

​
Your first API

ant generate api my-api
cd my-api
docker compose up --build
Your API is now running at http://localhost:5000.
The default project includes a working /default route, PostgreSQL, and Docker Compose — ready to extend immediately.

​
Next steps

generate api

Full reference for scaffolding a project

generate route

Add routes to an existing project

JSON Spec

Define your entire API in a single JSON file

Configuration

Set up environment variables and your database