Skip to main content

Overview

The ExpressoTS CLI is a command-line interface tool that helps you to create ExpressoTS projects and scaffold the application resources such as use cases, controllers, dto's, providers and services.

info

We use the npm package manager in this tutorial, but you can use your favorite package manager, such as yarn or pnpm.

Installation​

First install the CLI globally using the command below:

npm install -g @expressots/cli

Basic usage​

expressots <command> [options]

Help​

Verify the available commands and options:

expressots --help

Info​

Providers information about your Operational System, Project and CLI version:

expressots info or i

Resources list​

List all available resources to scaffold:

expressots resources or r

Resources

Create a Project​

There are two options to create a new project, interactively or silently (passing the options as arguments). Here is the complete command syntax:

expressots new <project-name> -p <package-manager> -t <template> -d <directory>

Interactively​

expressots new <project-name>

Silently​

expressots new <project-name> -p <package-manager> -t <template> -d <directory>
  • package-manager: npm, yarn or pnpm
  • template: opinionated or non-opinionated
  • directory: ./my-project

The flag -d is optional and is used to specify the directory where the project will be created. If not specified, the project will be created in the current directory.

Support the Project​

ExpressoTS is an MIT-licensed open source project. It's an independent project with ongoing development made possible thanks to your support. If you'd like to help, please consider: