CLI reference

Entrance

The TEO CLI commands have two entrances CONCEPT. Use the Teo command line tool to access with the CLI entrance. Use the backend programming language specific program to access with the APP entrance.

Use the CLI entrance

To use the CLI entrance, just use the Teo program.

Use the APP entrance

To use the APP entrance, invoke the entry script or the compiled binary.

Shared options

OptionShortTypeDescription
--schema <SCHEMA_FILE>-sStringThe schema file to load
--version-vBoolPrint version information
--silent-SBoolSilent outputs
--help-hBoolPrint help

serve

Use the serve command to start the HTTP server.

Options

OptionShortTypeDescription
--no-migration-MBoolStart server without running migration
--no-autoseed-SBoolStart server without auto seeding autoseed dataset

generate

Use the generate command to generate source code from Teo schema.

entity

Use the generate entity command to generate model entities.

Usage

generate entity [OPTIONS] [NAME]...

Options

OptionShortTypeDescription
--all-aBoolGenerate all entities

client

Use the generate client command to generate query clients.

Usage

generate client [OPTIONS] [NAME]...

Options

OptionShortTypeDescription
--all-aBoolGenerate all clients

admin

Use the generate admin command to generate an admin dashboard.

Usage

generate admin

migrate

Use the migrate command to perform database migration.

Options

OptionShortTypeDescription
--dry-dBoolDry run

seed

Use the seed command to seed data to the database.

Usage

seed [OPTIONS] [NAME]...

Options

OptionShortTypeDescription
--reseed-rBoolReseed records CONCEPT
--unseed-rBoolUnseed records CONCEPT

purge

Use the purge CONCEPT command to clear the database.

Usage

purge

lint

Use the lint CONCEPT command to validate schemas.

run

Use the run command to run custom programs CONCEPT.

Usage

run [NAME]...