@teliagen/cli

The official Command Line Interface for Teliagen.

@teliagen/cli provides a suite of tools to scaffold, develop, and manage Teliagen applications. It is designed to be the entry point for all development workflows within the Teliagen ecosystem.

Installation

You can run the CLI directly using npx (recommended for creating new projects) or install it globally.

Using npx

npx @teliagen/cli create my-app

Global Install

npm install -g @teliagen/cli
# or
pnpm add -g @teliagen/cli

Core Commands

create <name>

Scaffolds a new Teliagen project with the best practices and directory structure pre-configured.

teliagen create my-awesome-app

dev

Starts the development server with hot-reloading and automatic TypeScript compilation.

teliagen dev --port 3000

build

Builds the application for production.

teliagen build

start

Runs the compiled production application.

teliagen start

generate

Manually triggers the code generation process (metadata, types, and entity models) based on your backend code. Useful for updating client SDKs without running the dev server.

teliagen generate

Blueprint Commands

Blueprints are reusable modules that give your application new capabilities.

blueprint add <name>

Adds a new resource module (blueprint) to your existing application. This includes generating entities, actions, and services based on predefined templates.

teliagen blueprint add product

blueprint create <name>

Scaffolds a new custom blueprint structure, allowing you to create your own reusable modules.

teliagen blueprint create my-custom-module

blueprint list

Lists all available blueprints that can be added to your project.

teliagen blueprint list

Architecture

The CLI is built with flexibility in mind, leveraging:

• Commander.js for command parsing.
• Inquirer for interactive prompts.
• Teliagen Blueprint engine for code generation.

Documentation

For full documentation, visit docs.teliagen.org.

License

Apache-2.0