Skip to content

Command Line Interface

Quick Reference

Terminal window
language-pipes # Launch interactive TUI
language-pipes -c config.toml # Launch TUI with a config preloaded
language-pipes -c config.toml --start # Launch TUI and start serving immediately
language-pipes -c config.toml run # Run headless from a config file
language-pipes -c config.toml config # Print the configuration
language-pipes keygen [output] # Generate an AES encryption key

Argument order matters. -c/--config, --start, -v, and -h are options on the top-level command and must appear before the subcommand (run, config, keygen). For example, language-pipes run -c config.toml fails — use language-pipes -c config.toml run.

Global Options

These are parsed by the top-level language-pipes command and apply to every subcommand. They must be given before the subcommand name.

OptionDescriptionDefault
-h, --helpShow help message and exit
-v, --versionPrint the version and exit
-c FILE, --config FILEConfiguration to load (see below)Show Main Menu
--startSkip the startup confirmation and begin serving immediatelyfalse

How --config is resolved

The value passed to -c/--config is interpreted as follows:

  • If it contains .toml, it is treated as a path to a TOML file.
  • Otherwise it is treated as the name of a saved configuration and resolved to <app_dir>/configs/<name>.toml.

If the resolved file does not exist, the command exits immediately with:

ERROR: <value> is not a valid path or saved configuration

See Configuration for all available properties, types, and defaults.


Commands

language-pipes (no subcommand)

Launches the interactive TUI for creating, viewing, editing, and loading configurations.

Terminal window
language-pipes # Open the main menu
language-pipes -c config.toml # Open with a configuration preloaded
language-pipes -c config.toml --start # Open and begin serving immediately
  • -c/--config preloads a configuration instead of showing the main menu.
  • --start begins serving all configured services without waiting for confirmation.

In TUI mode the configuration file is authoritative. Environment variables and flags do not override config values. The exceptions are machine-local settings (LP_APP_DIR, LP_MODEL_DIR, LP_HUGGINGFACE_TOKEN), which describe the host environment rather than the node’s behavior.


run

Start a Language Pipes server node without the TUI, streaming output to stdout.

Format:

Terminal window
language-pipes -c FILE run

A configuration is required. If -c/--config is not provided, the command exits with:

ERROR: --config param required

The configuration file is resolved the same way as the global --config option (a .toml path, or a saved configuration name under <app_dir>/configs/).

Terminal window
language-pipes -c config.toml run
language-pipes -c node4 run # resolves <app_dir>/configs/node4.toml

config

Resolve a configuration file and print its settings as a human-readable report (ports, API keys, layer models, end models, and network settings).

Format:

Terminal window
language-pipes -c FILE config

A configuration is required (-c/--config), resolved the same way as run.

Example:

Terminal window
$ language-pipes -c node4.toml config
============================================================
--- Configuration Settings ---
============================================================
Job Port: 8000
API Keys:
- None
Layer Models:
- None
End Models:
- None
============================================================
DSNode Configuration Details
============================================================
--- Node Settings ---
Node ID: node-4
...

The output is a formatted report intended for inspection. It is not valid TOML and is not designed to be piped back into a configuration file.


keygen

Generate an AES encryption key for network communication and write it to disk.

Format:

Terminal window
language-pipes keygen [output]
ArgumentDescriptionDefault
outputOutput file pathnetwork.key

Example:

Terminal window
$ language-pipes keygen network.key
Network key generated: <key>
Network key saved to 'network.key'

Examples

Launch the TUI with a saved configuration

Terminal window
language-pipes -c node4

Run a node headless from a config file

Terminal window
language-pipes -c config.toml run

Run a node headless and log to a file as well as the terminal

Terminal window
language-pipes -c node4.toml run | tee node4.log

Inspect the configuration

Terminal window
language-pipes -c node4.toml config

Generate a network key

Terminal window
language-pipes keygen network.key