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.

cargo teo --help

Use the APP entrance

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

cargo run -- --help

Shared options

Option	Short	Type	Description
--schema <SCHEMA_FILE>	-s	String	The schema file to load
--version	-v	Bool	Print version information
--silent	-S	Bool	Silent outputs
--help	-h	Bool	Print help

`serve`

Use the serve command to start the HTTP server.

Options

Option	Short	Type	Description
--no-migration	-M	Bool	Start server without running migration
--no-autoseed	-S	Bool	Start 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

Option	Short	Type	Description
--all	-a	Bool	Generate all entities

`client`

Use the generate client command to generate query clients.

Usage

generate client [OPTIONS] [NAME]...

Options

Option	Short	Type	Description
--all	-a	Bool	Generate 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

Option	Short	Type	Description
--dry	-d	Bool	Dry run

`seed`

Use the seed command to seed data to the database.

Usage

seed [OPTIONS] [NAME]...

Options

Option	Short	Type	Description
--reseed	-r	Bool	Reseed records CONCEPT
--unseed	-r	Bool	Unseed 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]...