p-sw fedbc8c168 refactor(cli): update commands and README for pswui CLI
The pswui CLI documentation has been updated to reflect the current commands and to give clearer instructions. Changes include replacing "mycli123" with "pswui" throughout the document, reducing the number of commands to three - add, help, and list, and updating their descriptions and examples for better understanding.
2024-06-07 00:51:59 +09:00
..
2024-06-06 19:00:53 +09:00
2024-06-06 19:00:53 +09:00
2024-06-06 19:00:53 +09:00
2024-06-06 19:00:53 +09:00
2024-06-06 19:00:53 +09:00
2024-06-06 19:00:53 +09:00
2024-06-06 19:00:53 +09:00
2024-06-06 19:00:53 +09:00

@psw-ui/cli

CLI for PSW/UI

oclif Version Downloads/week

Usage

$ npm install -g @psw-ui/cli
$ pswui COMMAND
running command...
$ pswui (--version)
@psw-ui/cli/0.1.0 linux-x64 node-v20.13.1
$ pswui --help [COMMAND]
USAGE
  $ pswui COMMAND
...

Commands

pswui add [NAME]

Add a component to the project.

USAGE
  $ pswui add [NAME] [-f] [-F] [-p <value>] [-s <value>] [-c <value>]

ARGUMENTS
  NAME  name of component to install

FLAGS
  -F, --forceShared         override the existing shared.ts and update it to latest
  -c, --components=<value>  place for installation of components
  -f, --force               override the existing file
  -p, --config=<value>      path to config
  -s, --shared=<value>      place for installation of shared.ts

DESCRIPTION
  Add a component to the project.

EXAMPLES
  $ pswui add

See code: src/commands/add.ts

pswui help [COMMAND]

Display help for pswui.

USAGE
  $ pswui help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for pswui.

See code: @oclif/plugin-help

pswui list

Prints all available components in registry and components installed in this project.

USAGE
  $ pswui list [-u] [-p <value>]

FLAGS
  -p, --config=<value>  path to config
  -u, --url             include component file URL

DESCRIPTION
  Prints all available components in registry and components installed in this project.

EXAMPLES
  $ pswui list

See code: src/commands/list.ts