Frontstack CLI

Frontstack CLI is a command line interface for using Frontstack in local development.

It allows you to login to you Frontstack account, push local changes to a project or generate the API client for a project and environment.

Usage

$ npx @frontstackdev/cli

  frontstack CLI

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

  Commands:
      login               Connect the CLI with you Frontstack account
      logout              Disconnect the CLI from your Frontstack account 
      info                Show information about current project and user
      project [options]   Set current project
      generate [options]  Generate a JavaScript client for your project
      
      help [command]      display help for command

Commands

frontstack login

Login to your Frontstack account. You will be redirected to the Frontstack website to authenticate and authorize the CLI. After authorizing, you can select a project to work with using frontstack project.

frontstack info

Provides information about the currently logged in user, their organization and currently selected project.

frontstack project

Select current working project or display all projects

# List and select a project
frontstack project

# Select a project by ID
frontstack project -p a2dc8820-2e52-427a-8d58-0256f28d3db9

frontstack generate

Generate a JavaScript client for your specific project and environment.

Before running this command, make sure a current working project is selected, using frontstack project

Development

Configs are set in the config.ts file. You can also control the configs using environment variables.

Configure

By default, the CLI uses the public Frontstack API instance. You can either override the URL directly

FRONTSTACK_CLI_API_ROOT=[your-url] pnpm frontstack login

or enable dev mode (which uses the local Frontstack API instance)

FRONTSTACK_CLI_DEV_MODE=1 pnpm frontstack login

Run

There are two options to run the CLI in development mode:

1. Building the app and running the built file (recommended)

   $ pnpm frontstack [command] // e.g. pnpm frontstack info

2. Run using tsx (this will compile the typescript files on the fly)

   $ pnpm start [command] // e.g. pnpm start info

Build

The application is built using pkgroll. The CLI is exported as an ES module and compiled to a single file in the dist folder.

Build the file using pnpm build and run it using node dist/frontstack.mjs.