https://github.com/folio-org/stripes-cli
Command line interface for creating, building, and testing Stripes UI modules.
https://github.com/folio-org/stripes-cli
Last synced: 10 months ago
JSON representation
Command line interface for creating, building, and testing Stripes UI modules.
- Host: GitHub
- URL: https://github.com/folio-org/stripes-cli
- Owner: folio-org
- License: apache-2.0
- Created: 2017-11-03T15:53:35.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-06-11T11:41:43.000Z (about 1 year ago)
- Last Synced: 2025-08-15T08:56:37.770Z (10 months ago)
- Language: JavaScript
- Size: 1.46 MB
- Stars: 11
- Watchers: 20
- Forks: 15
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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](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](./doc/user-guide.md)
* [List of Commands](./doc/commands.md)
* [Developer Guide](./doc/dev-guide.md)
* [Back-end Guide](./doc/backend-guide.md)
* [Troubleshooting](./doc/troubleshooting.md)
## Installation
Stripes CLI is available on both the `npm-folio` and `npm-folioci` registries. Refer to [configuring the FOLIO registry](https://github.com/folio-org/stripes/blob/master/doc/new-development-setup.md#configure-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](https://issues.folio.org/browse/STCLI) in the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker).