p-sw/pswui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
pswui/packages/cli/README.md
p-sw 7bf2578d86 docs(cli): update code reference links in README to version 0.3.0 
The commit updates the README file located in the CLI package. It mainly changes the links that refer to the code of the `add`, `list`, and `search` commands. The references in those links are now pointing to the 0.3.0 version instead of the 0.2.1 version.
2024-06-11 16:40:35 +09:00

2.7 KiB
Raw Blame History

@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.2.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: packages/cli/src/commands/add.tsx

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: packages/cli/src/commands/list.ts

pswui search

Search components.

Search components.

USAGE
  $ pswui search [QUERY]

ARGUMENTS
  QUERY  search query

DESCRIPTION
  Search components.

EXAMPLES
  $ pswui search

See code: packages/cli/src/commands/search.tsx