UNPKG

@pluralsight/pando

Version:

Official CLI for the Pando Design System.

design.pluralsight.com

pluralsight/pando

34 lines (18 loc) • 1.31 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# Pando CLI The Pando CLI is a command line interface for Pando. It is used to help manage setting up a Pando project or maintaining an existing one. ## What role does this package play in Pando? This is the official entry point to using Pando. It generates the files needed for development and installs any dependencies needed to get started. Likewise, it is used to update the project as new versions of Pando are released and help the user to know when there is a new version available. ### Pando CLI General Function The Pando CLI should be used to install Pando or do anything relative to Pando in general. By all means, this is the "user interface" of Pando. ## Install This project uses pnPm so there are no setup commands needed. If you get any errors, you may need to run an initial `pnpm install` or ensure you are using Node >= 18. ## Development To use this project in development, simply run the bin commands exposed. ## Testing From the **root directory of the project**, run: ```bash pnpm -w test ``` ## Contribution If you plan on contributing to this project, please take time to read our [CONTRIBUTING.md](https://github.com/pluralsight/pando/blob/main/CONTRIBUTING.md). Pull requests that do not adhere to the requirements in this doc will automatically be flagged and closed.