p-sw/pswui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(cli): update docs

Browse Source
This commit is contained in:
p-sw 2024-06-15 03:51:23 +09:00
parent 024ae50738
commit 02b2c1ac2d
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
packages/cli/README.md
View File

@ -20,7 +20,7 @@ $ npm install -g @psw-ui/cli
$ pswui COMMAND $ pswui COMMAND
running command... running command...
$ pswui (--version) $ pswui (--version)
@psw-ui/cli/0.2.0 linux-x64 node-v20.13.1 @psw-ui/cli/0.5.0 linux-x64 node-v20.13.1
$ pswui --help [COMMAND] $ pswui --help [COMMAND]
USAGE USAGE
$ pswui COMMAND $ pswui COMMAND
@ -49,7 +49,7 @@ FLAGS
-c, --components=<value> place for installation of components -c, --components=<value> place for installation of components
-f, --force override the existing file -f, --force override the existing file
-p, --config=<value> path to config -p, --config=<value> path to config
-r, --registry=<value> override registry ur -r, --branch=<value> use other branch instead of main
-s, --shared=<value> place for installation of shared.ts -s, --shared=<value> place for installation of shared.ts
DESCRIPTION DESCRIPTION
@ -59,7 +59,7 @@ EXAMPLES
$ pswui add $ pswui add
``` ```
_See code: [packages/cli/src/commands/add.tsx](https://github.com/pswui/ui/blob/cli@0.4.1/packages/cli/src/commands/add.tsx)_ _See code: [packages/cli/src/commands/add.tsx](https://github.com/pswui/ui/blob/cli@0.5.0/packages/cli/src/commands/add.tsx)_
## `pswui help [COMMAND]` ## `pswui help [COMMAND]`
@ -91,7 +91,7 @@ USAGE
FLAGS FLAGS
-p, --config=<value> path to config -p, --config=<value> path to config
-r, --registry=<value> override registry url -r, --branch=<value> use other branch instead of main
-u, --url include component file URL -u, --url include component file URL
DESCRIPTION DESCRIPTION
@ -101,7 +101,7 @@ EXAMPLES
$ pswui list $ pswui list
``` ```
_See code: [packages/cli/src/commands/list.ts](https://github.com/pswui/ui/blob/cli@0.4.1/packages/cli/src/commands/list.ts)_ _See code: [packages/cli/src/commands/list.ts](https://github.com/pswui/ui/blob/cli@0.5.0/packages/cli/src/commands/list.ts)_
## `pswui search` ## `pswui search`
@ -117,7 +117,7 @@ ARGUMENTS
QUERY search query QUERY search query
FLAGS FLAGS
-r, --registry=<value> override registry url -r, --branch=<value> use other branch instead of main
DESCRIPTION DESCRIPTION
Search components. Search components.
@ -126,5 +126,5 @@ EXAMPLES
$ pswui search $ pswui search
``` ```
_See code: [packages/cli/src/commands/search.tsx](https://github.com/pswui/ui/blob/cli@0.4.1/packages/cli/src/commands/search.tsx)_ _See code: [packages/cli/src/commands/search.tsx](https://github.com/pswui/ui/blob/cli@0.5.0/packages/cli/src/commands/search.tsx)_
<!-- commandsstop --> <!-- commandsstop -->