🛵 Sidecar CLI

Sidecar is a TypeScript abstraction layer for backends built with love by your friends at Userfront.

Use this command line interface to initialize new project assets, modules, and assist with local development.

Getting Started

Prerequisites

• Node v20 (recommended to use nvm)

Quick Start

Download and install the CLI globally:

npm install -g @userfront/sidecar-cli

Installing a package globally allows you to use the code in the package as a set of tools on your local computer.

Usage

The sidecar command can be called once installed (with npm v5.2+ use npx sidecar).

sidecar [namespace] [action] [...args]

When called without arguments, it will display its command usage and help document:

$ sidecar

Usage: sidecar [options] [command]

Initialize new project assets, modules, and assist with local development

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  module          create new or manage existing modules
  help [command]  display help for command