Skip to content

Commit 198a7c8

Browse files
committed
add instructions to run the pyscript command in dev
1 parent 4b674ca commit 198a7c8

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,37 @@ After setting up your developer enviroment, you can run the tests with the follo
5454
pytest .
5555
```
5656

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+
5788
## Documentation
5889

5990
### Install the documentation dependencies

0 commit comments

Comments
 (0)