Skip to main content

Gesso Command Line Interface

Overview​

The Gesso CLI allows you to interact with your project from the command line. It provides a set of commands to help you develop and build Gesso apps.

Installation​

pnpm install @acromedia/gesso-cli

Usage​

To execute a command, prefix it with pnpm gesso.

pnpm gesso <command>

Here's a list of the available commands:

  • generate-stories
  • localize-deps
  • construct
  • config
  • create-component
  • health

generate-stories​

The command generate-stories is used in the design-system of your project and allows you to automatically grab the most recent Gesso stories. You can find the generated stories in src/stories/gesso.

  • If you don't want some of the stories, just delete the associated files.

  • You can edit the files and still recieve upstream changes, as they are published exports, not copies.

  • Updates will happen automatically when you update your Gesso version, although if you wish to get new stories, you will need to run the command or manually create the missing files.