File tree Expand file tree Collapse file tree 1 file changed +31
-0
lines changed Expand file tree Collapse file tree 1 file changed +31
-0
lines changed Original file line number Diff line number Diff line change @@ -54,6 +54,37 @@ After setting up your developer enviroment, you can run the tests with the follo
54
54
pytest .
55
55
```
56
56
57
+ # Running CLI Commands
58
+
59
+ Once the installation process is done, the ` pyscript ` CLI is avaible to be used once the environment has been
60
+ activated. Simply run ` pyscript ` with the appropriate command. For instance, to see the list of commands:
61
+
62
+ ``` shell
63
+ >> pyscript --help
64
+
65
+ Usage: pyscript [OPTIONS] COMMAND [ARGS]...
66
+
67
+ Command Line Interface for PyScript.
68
+
69
+ ╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
70
+ │ --version Show project version and exit. │
71
+ │ --help Show this message and exit. │
72
+ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
73
+ ╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
74
+ │ create Create a new pyscript project with the passed in name, creating a new directory in the current directory. Alternatively, use ` --wrap` so as to embed a │
75
+ │ python file instead. │
76
+ │ run Creates a local server to run the app on the path and port specified. │
77
+ ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
78
+ ```
79
+
80
+ or, to run a pyscript app:
81
+
82
+ ``` shell
83
+ >> pyscript run
84
+ Serving from /pyscript-example at port 8000. To stop, press Ctrl+C.
85
+ 127.0.0.1 - - [30/Apr/2025 17:01:03] " GET / HTTP/1.1" 200 -
86
+ ```
87
+
57
88
## Documentation
58
89
59
90
### Install the documentation dependencies
You can’t perform that action at this time.
0 commit comments