add page for flags

pull/289/head
Mike Bird 6 months ago
parent 9ba89177d2
commit 8d10679d5e

@ -41,7 +41,7 @@
},
{
"group": "Software Setup",
"pages": ["software/installation", "software/setup"]
"pages": ["software/installation", "software/setup", "software/flags"]
},
{
"group": "Hardware Setup",

@ -0,0 +1,77 @@
---
title: "Flags"
description: "Customize the behaviour of your 01"
---
## CLI Flags
- `--server`
Run server.
- `--server-host TEXT`
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.
Default: `10001`.
- `--tunnel-service TEXT`
Specify the tunnel service.
Default: `ngrok`.
- `--expose`
Expose server to internet.
- `--server-url TEXT`
Specify the server URL that the client should expect.
Defaults to server-host and server-port.
Default: `None`.
- `--llm-service TEXT`
Specify the LLM service.
Default: `litellm`.
- `--model TEXT`
Specify the model.
Default: `gpt-4`.
- `--llm-supports-vision`
Specify if the LLM service supports vision.
- `--llm-supports-functions`
Specify if the LLM service supports functions.
- `--context-window INTEGER`
Specify the context window size.
Default: `2048`.
- `--max-tokens INTEGER`
Specify the maximum number of tokens.
Default: `4096`.
- `--temperature FLOAT`
Specify the temperature for generation.
Default: `0.8`.
- `--tts-service TEXT`
Specify the TTS service.
Default: `openai`.
- `--stt-service TEXT`
Specify the STT service.
Default: `openai`.
- `--local`
Use recommended local services for LLM, STT, and TTS.
- `--install-completion [bash|zsh|fish|powershell|pwsh]`
Install completion for the specified shell.
Default: `None`.
- `--show-completion [bash|zsh|fish|powershell|pwsh]`
Show completion for the specified shell, to copy it or customize the installation.
Default: `None`.
- `--help`
Show this message and exit.

@ -41,76 +41,3 @@ You are able to pass CLI flags `--tts-service` and/or `--stt-service` with the d
These different service providers can be found in `/services/stt` and `/services/tts`
For more information, please read about <a href="/services/speech-to-text">speech-to-text</a> and <a href="/services/text-to-speech">text-to-speech</a>
## CLI Flags
- `--server`
Run server.
- `--server-host TEXT`
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.
Default: `10001`.
- `--tunnel-service TEXT`
Specify the tunnel service.
Default: `ngrok`.
- `--expose`
Expose server to internet.
- `--server-url TEXT`
Specify the server URL that the client should expect.
Defaults to server-host and server-port.
Default: `None`.
- `--llm-service TEXT`
Specify the LLM service.
Default: `litellm`.
- `--model TEXT`
Specify the model.
Default: `gpt-4`.
- `--llm-supports-vision`
Specify if the LLM service supports vision.
- `--llm-supports-functions`
Specify if the LLM service supports functions.
- `--context-window INTEGER`
Specify the context window size.
Default: `2048`.
- `--max-tokens INTEGER`
Specify the maximum number of tokens.
Default: `4096`.
- `--temperature FLOAT`
Specify the temperature for generation.
Default: `0.8`.
- `--tts-service TEXT`
Specify the TTS service.
Default: `openai`.
- `--stt-service TEXT`
Specify the STT service.
Default: `openai`.
- `--local`
Use recommended local services for LLM, STT, and TTS.
- `--install-completion [bash|zsh|fish|powershell|pwsh]`
Install completion for the specified shell.
Default: `None`.
- `--show-completion [bash|zsh|fish|powershell|pwsh]`
Show completion for the specified shell, to copy it or customize the installation.
Default: `None`.
- `--help`
Show this message and exit.

Loading…
Cancel
Save