Skip to content

Commit f4236c0

Browse files
committed
update readme
1 parent 6cabb4d commit f4236c0

File tree

1 file changed

+32
-7
lines changed

1 file changed

+32
-7
lines changed

README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,26 +29,51 @@ This is a
2929

3030
## Installation
3131

32+
There are a few ways to install and run.
33+
34+
### Clone & Run Locally
3235
Clone this repository, enter the `pyxtermjs` directory, then run:
36+
```
37+
> python -m venv venv # must be python3.6+
38+
> venv/bin/pip install -r requirements.txt
39+
> venv/bin/python -m pyxtermjs
40+
serving on http://127.0.0.1:5000
41+
```
42+
43+
### Install or Run latest version on PyPI
44+
You can use [pipx](https://github.com/pipxproject/pipx) to try it out.
45+
```
46+
> pipx run pyxtermjs
47+
serving on http://127.0.0.1:5000
48+
```
3349

50+
You can also and have `pyxtermjs` installed in an isolated environment, yet available on your $PATH with
51+
```
52+
> pipx install pyxtermjs
3453
```
35-
python3 -m venv venv # must be python3.6+
36-
venv/bin/pip install -r requirements.txt
37-
venv/bin/python -m pyxtermjs
54+
55+
### Run from GitHub source
56+
Use [pipx](https://github.com/pipxproject/pipx) for this as well.
3857
```
58+
> pipx run --spec git+https://github.com/cs01/pyxtermjs.git pyxtermjs
59+
serving on http://127.0.0.1:5000
60+
```
61+
3962

40-
## Documentation
63+
## API
4164
```
42-
>> pyxtermjs --help
43-
usage: pyxtermjs [-h] [-p PORT] [--debug] [--version] [--command COMMAND]
44-
[--cmd-args CMD_ARGS]
65+
> pyxtermjs --help
66+
usage: pyxtermjs [-h] [-p PORT] [--host HOST] [--debug] [--version]
67+
[--command COMMAND] [--cmd-args CMD_ARGS]
4568
4669
A fully functional terminal in your browser.
4770
https://github.com/cs01/pyxterm.js
4871
4972
optional arguments:
5073
-h, --help show this help message and exit
5174
-p PORT, --port PORT port to run server on (default: 5000)
75+
--host HOST host to run server on (use 0.0.0.0 to allow access
76+
from other hosts) (default: 127.0.0.1)
5277
--debug debug the server (default: False)
5378
--version print version and exit (default: False)
5479
--command COMMAND Command to run in the terminal (default: bash)

0 commit comments

Comments
 (0)