folio-org / stripes-cli

Command line interface for creating, building, and testing Stripes UI modules.

Stripes CLI

Copyright (C) 2017-2023 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

Stripes CLI is a command line interface to facilitate the creation, development, building, and testing of Stripes UI modules.

• User Guide
• List of Commands
• Developer Guide
• Back-end Guide
• Troubleshooting

Installation

Stripes CLI is available on both the npm-folio and npm-folioci registries. Refer to configuring the FOLIO registry for information on which registry to use. The following shows how to install the CLI globally from npm-folio:

yarn config set @folio:registry https://repository.folio.org/repository/npm-folio/
yarn global add @folio/stripes-cli

Upgrading

Upgrade your globally installed CLI with the following command:

$ yarn global upgrade @folio/stripes-cli

If your CLI is installed locally, use:

$ yarn upgrade @folio/stripes-cli

Issues

See project STCLI in the FOLIO issue tracker.