pswui/packages/cli/README.md

@psw-ui/cli

CLI for PSW/UI

• Usage
• Commands

Usage

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

Commands

• pswui add [NAME]
• pswui help [COMMAND]
• pswui list
• pswui search

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
  -c, --components=<value>  place for installation of components
  -f, --force               override the existing file
  -p, --config=<value>      path to config
  -r, --branch=<value>      use other branch instead of main
  -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
  -r, --branch=<value>  use other branch instead of main
  -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

FLAGS
  -r, --branch=<value>  use other branch instead of main

DESCRIPTION
  Search components.

EXAMPLES
  $ pswui search

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