Installation

Install the Apso CLI when you want to generate and run a backend from your terminal. The CLI supports TypeScript with NestJS, Python with FastAPI, and Go with Gin.

Prerequisites

• Node.js 18 or newer
• Git
• npm, pnpm, or Yarn

Docker is optional. The TypeScript local workflow can use PGlite, while apso dev --docker runs a container-based environment.

Install the CLI

npm install -g @apso/cli

pnpm add -g @apso/cli

yarn global add @apso/cli

Verify that the executable is available:

apso --version
apso doctor

Choose a project mode

Local project

Use offline mode to generate and run code without an Apso Cloud account:

apso init --name task-api --language typescript --skip-platform
cd task-api

Change typescript to python or go to select another generated framework.

Cloud-linked project

Authenticate, select a workspace, and initialize the service:

apso login
apso whoami
apso use your-workspace-slug
apso init --name task-api --language typescript
cd task-api

Interactive apso init can prompt for the project and language. In CI or another non-interactive environment, always provide --name and --language.

Verify the project

Every generated project includes .apsorc, the schema contract used by apso generate:

apso schema validate
apso generate
apso dev

The exact local port comes from the generated template. The TypeScript quickstart uses APP_PORT=3100 and exposes OpenAPI at http://localhost:3100/_docs.

Next steps