8f6b9d6443* chore: Add type attribute to button in SecretKeyModal * chore: Refactor Header component to fix autoLogin button visibility * docs(api.mdx): update admonition message to remove reference to LANGFLOW_AUTO_LOGIN environment variable docs(cli.mdx): update CLI command example to use 'run' subcommand instead of no arguments feat(cli.mdx): add 'api-key' command to create API key for default superuser when LANGFLOW_AUTO_LOGIN is True * docs(api.mdx): update admonition message to remove reference to LANGFLOW_AUTO_LOGIN environment variable * chore: Fix typo in get-curl-code.tsx --------- Co-authored-by: anovazzi1 <otavio2204@gmail.com>
77 lines
6.7 KiB
Text
77 lines
6.7 KiB
Text
# Command Line Interface (CLI)
|
|
|
|
## Overview
|
|
|
|
Langflow's Command Line Interface (CLI) is a powerful tool that allows you to interact with the Langflow server from the command line. The CLI provides a wide range of commands to help you shape Langflow to your needs.
|
|
|
|
Running the CLI without any arguments will display a list of available commands and options.
|
|
|
|
```bash
|
|
python -m langflow run --help
|
|
# or
|
|
python -m langflow run
|
|
```
|
|
|
|
Each option for `run` command are detailed below:
|
|
|
|
- `--help`: Displays all available options.
|
|
- `--host`: Defines the host to bind the server to. Can be set using the `LANGFLOW_HOST` environment variable. The default is `127.0.0.1`.
|
|
- `--workers`: Sets the number of worker processes. Can be set using the `LANGFLOW_WORKERS` environment variable. The default is `1`.
|
|
- `--timeout`: Sets the worker timeout in seconds. The default is `60`.
|
|
- `--port`: Sets the port to listen on. Can be set using the `LANGFLOW_PORT` environment variable. The default is `7860`.
|
|
- `--env-file`: Specifies the path to the .env file containing environment variables. The default is `.env`.
|
|
- `--log-level`: Defines the logging level. Can be set using the `LANGFLOW_LOG_LEVEL` environment variable. The default is `critical`.
|
|
- `--components-path`: Specifies the path to the directory containing custom components. Can be set using the `LANGFLOW_COMPONENTS_PATH` environment variable. The default is `langflow/components`.
|
|
- `--log-file`: Specifies the path to the log file. Can be set using the `LANGFLOW_LOG_FILE` environment variable. The default is `logs/langflow.log`.
|
|
- `--cache`: Select the type of cache to use. Options are `InMemoryCache` and `SQLiteCache`. Can be set using the `LANGFLOW_LANGCHAIN_CACHE` environment variable. The default is `SQLiteCache`.
|
|
- `--dev/--no-dev`: Toggles the development mode. The default is `no-dev`.
|
|
- `--path`: Specifies the path to the frontend directory containing build files. This option is for development purposes only. Can be set using the `LANGFLOW_FRONTEND_PATH` environment variable.
|
|
- `--open-browser/--no-open-browser`: Toggles the option to open the browser after starting the server. Can be set using the `LANGFLOW_OPEN_BROWSER` environment variable. The default is `open-browser`.
|
|
- `--remove-api-keys/--no-remove-api-keys`: Toggles the option to remove API keys from the projects saved in the database. Can be set using the `LANGFLOW_REMOVE_API_KEYS` environment variable. The default is `no-remove-api-keys`.
|
|
- `--install-completion [bash|zsh|fish|powershell|pwsh]`: Installs completion for the specified shell.
|
|
- `--show-completion [bash|zsh|fish|powershell|pwsh]`: Shows completion for the specified shell, allowing you to copy it or customize the installation.
|
|
- `--backend-only`: This parameter, with a default value of `False`, allows running only the backend server without the frontend. It can also be set using the `LANGFLOW_BACKEND_ONLY` environment variable.
|
|
- `--store`: This parameter, with a default value of `True`, enables the store features, use `--no-store` to deactivate it. It can be configured using the `LANGFLOW_STORE` environment variable.
|
|
|
|
These parameters are important for users who need to customize the behavior of Langflow, especially in development or specialized deployment scenarios.
|
|
|
|
### API Key Command
|
|
|
|
The `api-key` command allows you to create an API key for accessing Langflow's API when `LANGFLOW_AUTO_LOGIN` is set to `True`.
|
|
|
|
```bash
|
|
python -m langflow api-key --help
|
|
|
|
Usage: langflow api-key [OPTIONS]
|
|
|
|
Creates an API key for the default superuser if AUTO_LOGIN is enabled.
|
|
Args: log_level (str, optional): Logging level. Defaults to "error".
|
|
Returns: None
|
|
|
|
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
│ --log-level TEXT Logging level. [env var: LANGFLOW_LOG_LEVEL] [default: error] │
|
|
│ --help Show this message and exit. │
|
|
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
```
|
|
|
|
Once you run the `api-key` command, it will create an API key for the default superuser if `LANGFLOW_AUTO_LOGIN` is set to `True`.
|
|
|
|
```bash
|
|
python -m langflow api-key
|
|
╭─────────────────────────────────────────────────────────────────────╮
|
|
│ API Key Created Successfully: │
|
|
│ │
|
|
│ sk-O0elzoWID1izAH8RUKrnnvyyMwIzHi2Wk-uXWoNJ2Ro │
|
|
│ │
|
|
│ This is the only time the API key will be displayed. │
|
|
│ Make sure to store it in a secure location. │
|
|
│ │
|
|
│ The API key has been copied to your clipboard. Cmd + V to paste it. │
|
|
╰─────────────────────────────────────────────────────────────────────╯
|
|
```
|
|
|
|
### Environment Variables
|
|
|
|
You can configure many of the CLI options using environment variables. These can be exported in your operating system or added to a `.env` file and loaded using the `--env-file` option.
|
|
|
|
A sample `.env` file named `.env.example` is included with the project. Copy this file to a new file named `.env` and replace the example values with your actual settings. If you're setting values in both your OS and the `.env` file, the `.env` settings will take precedence.
|