|
|
|
---
|
|
|
|
title: "Flags"
|
|
|
|
description: "Customize the behaviour of your 01 from the CLI"
|
|
|
|
---
|
|
|
|
|
|
|
|
## CLI Flags
|
|
|
|
|
|
|
|
### Server
|
|
|
|
|
|
|
|
Runs the server.
|
|
|
|
|
|
|
|
```
|
|
|
|
poetry run 01 --server
|
|
|
|
```
|
|
|
|
|
|
|
|
### Server Host
|
|
|
|
|
|
|
|
Specify the server host where the server will deploy.
|
|
|
|
|
|
|
|
Default: `0.0.0.0`.
|
|
|
|
|
|
|
|
```
|
|
|
|
poetry run 01 --server-host 0.0.0.0
|
|
|
|
```
|
|
|
|
|
|
|
|
### Server Port
|
|
|
|
|
|
|
|
Specify the server port where the server will deploy.
|
|
|
|
|
|
|
|
Default: `10001`.
|
|
|
|
|
|
|
|
```
|
|
|
|
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
|
|
|
|
```
|