Skip to content

Commit ad3a633

Browse files
committed
Enhance README.md with usage instructions for htpyuikit CLI and add docstring to list command in cli.py for better clarity.
1 parent 8c67216 commit ad3a633

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,23 @@
2828
- **Add all**: `htpyuikit add --all --dest ./components`
2929
- **Theme**: `htpyuikit add-theme --dest ./styles/htpy-uikit.css`
3030

31+
```
32+
Usage: htpyuikit [OPTIONS] COMMAND [ARGS]...
33+
34+
htpy-uikit CLI: list and scaffold components into your app.
35+
36+
Options:
37+
--version Show the version and exit.
38+
-h, --help Show this message and exit.
39+
40+
Commands:
41+
add Copy one or more components into your app (with deps).
42+
add-theme Copy a theme CSS file into your app.
43+
list List available components.
44+
themes List available themes.
45+
```
46+
47+
3148
## Config (pyproject.toml)
3249

3350
```toml

src/htpy_uikit/cli.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ def cli() -> None:
151151

152152
@cli.command("list")
153153
def list_cmd() -> None:
154+
"""List available components."""
154155
comps = list_components()
155156
if not comps:
156157
click.echo("No components found.")

0 commit comments

Comments
 (0)