Enhance CLI flags with more detailed descriptions and usage examples.
This commit is contained in:
		
							parent
							
								
									5fabfb06f0
								
							
						
					
					
						commit
						976ebd444a
					
				| 
						 | 
					@ -7,7 +7,7 @@ description: "Preparing your machine"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
To run 01OS on your computer, you will need to install a few essential packages.
 | 
					To run 01OS on your computer, you will need to install a few essential packages.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Install poetry via [the recommended method](https://python-poetry.org/).
 | 
					Install [Poetry](https://python-poetry.org/).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### MacOS
 | 
					### MacOS
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -26,7 +26,6 @@ sudo apt-get install portaudio19-dev ffmpeg cmake
 | 
				
			||||||
### Windows
 | 
					### Windows
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- [Git for Windows](https://git-scm.com/download/win).
 | 
					- [Git for Windows](https://git-scm.com/download/win).
 | 
				
			||||||
- [virtualenv](https://virtualenv.pypa.io/en/latest/installation.html) or [MiniConda](https://docs.anaconda.com/free/miniconda/miniconda-install/) to manage virtual environments.
 | 
					 | 
				
			||||||
- [Chocolatey](https://chocolatey.org/install#individual) to install the required packages.
 | 
					- [Chocolatey](https://chocolatey.org/install#individual) to install the required packages.
 | 
				
			||||||
- [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools):
 | 
					- [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools):
 | 
				
			||||||
  - Choose [**Download Build Tools**](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
 | 
					  - Choose [**Download Build Tools**](https://visualstudio.microsoft.com/visual-cpp-build-tools/).
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -5,38 +5,98 @@ description: "Customize the behaviour of your 01 from the CLI"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## CLI Flags
 | 
					## CLI Flags
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- `--server`
 | 
					### Server
 | 
				
			||||||
  Run server.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
- `--server-host TEXT`
 | 
					Runs the server.
 | 
				
			||||||
  Specify the server host where the server will deploy.
 | 
					 | 
				
			||||||
  Default: `0.0.0.0`.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
- `--server-port INTEGER`
 | 
					```
 | 
				
			||||||
  Specify the server port where the server will deploy.
 | 
					poetry run 01 --server
 | 
				
			||||||
  Default: `10001`.
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- `--tunnel-service TEXT`
 | 
					### Server Host
 | 
				
			||||||
  Specify the tunnel service.
 | 
					 | 
				
			||||||
  Default: `ngrok`.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
- `--expose`
 | 
					Specify the server host where the server will deploy.
 | 
				
			||||||
  Expose server to internet.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
- `--client`
 | 
					Default: `0.0.0.0`.
 | 
				
			||||||
  Run client.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
- `--server-url TEXT`
 | 
					```
 | 
				
			||||||
  Specify the server URL that the client should expect.
 | 
					poetry run 01 --server-host 0.0.0.0
 | 
				
			||||||
  Defaults to server-host and server-port.
 | 
					```
 | 
				
			||||||
  Default: `None`.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
- `--client-type TEXT`
 | 
					### Server Port
 | 
				
			||||||
  Specify the client type.
 | 
					 | 
				
			||||||
  Default: `auto`.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
- `--qr`
 | 
					Specify the server port where the server will deploy.
 | 
				
			||||||
  Display QR code to scan to connect to the server.
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
- `--help`
 | 
					Default: `10001`.
 | 
				
			||||||
  Show this message and exit.
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					poetry run 01 --server-port 10001
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Tunnel Service
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Specify the tunnel service.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Default: `ngrok`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					poetry run 01 --tunnel-service ngrok
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Specify the tunnel service.
 | 
				
			||||||
 | 
					Default: `ngrok`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Expose
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Expose server to internet.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					poetry run 01 --expose
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Client
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Run client.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					poetry run 01 --client
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Server URL
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Specify the server URL that the client should expect.
 | 
				
			||||||
 | 
					Defaults sets the server-host and server-port.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Default: `None`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					poetry run 01 --server-url http://0.0.0.0:10001
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Client Type
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Specify the client type.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Default: `auto`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					poetry run 01 --client-type auto
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Default: `auto`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### QR
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Display QR code to scan to connect to the server.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					poetry run 01 --qr
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### Help
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Show this message and exit.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					poetry run 01 --help
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue