Command Line Options

When launching LedFx from the command line, or by editing properties of a desktop shortcut it is possible to add various launch options explained below.

--version: Display the current version of LedFx.
-c, --config <directory>: Specify the directory that contains the configuration files. Defaults to .ledfx in the user data directory according to host OS
--open-ui: Automatically open the web interface
-v, --verbose: Set log level to INFO.
-vv, --very-verbose: Set log level to DEBUG.
-p, --port <port>: Specify the web interface port (HTTP). Default 8888
-p_s, --port_secure <port>: Specify the web interface port (HTTPS). Default 8443 SSL certs must be present in the ledfx config directory
--host <address>: Specify the address to host the LedFx web interface. Default localhost, 127.0.0.1
--tray: Force LedFx system tray icon.
--no-tray: Force no LedFx system tray icon.
--offline: Disable crash logger and auto update checks.
--sentry-crash-test: Crash LedFx to test the sentry crash logger.
--ci-smoke-test: Launch LedFx and then exit after 5 seconds to sanity check the install.
--generate-typescript-types: Generate TypeScript types for the API and exit.
--clear-config: Launch LedFx, backup the config, clear the config, and continue with a clean startup.
--clear-effects: Launch LedFx, load the config, clear all active effects on all virtuals. Effect configurations are persisted, just turned off.
--pause-all: Start LedFx with all virtuals paused. This is a global pause and can be toggled via the UI, or via a rest PUT to /api/virtuals

Adding Command-Line Options to LedFx Launch

This guide explains how to add command-line options to the launch of ledfx across Windows, Linux, and macOS, including instructions for both creating new shortcuts and editing pre-existing ones.

Windows

Adding Options via Command Prompt

Open Command Prompt.
Navigate to the folder where ledfx is located using the cd command.
Run ledfx with the desired options appended to the command:
```
ledfx [options]
```

Adding Options to a Shortcut

Creating a New Shortcut

Right-click on your desktop or a folder and select New > Shortcut.
In the Type the location of the item field, provide the full path to the ledfx.exe executable, followed by the desired options:
```
"C:\Path\To\LedFx\ledfx.exe" [options]
```
Click Next, name the shortcut (e.g., LedFx Custom Launch), and click Finish.
Double-click the shortcut to launch ledfx with the specified options.

Editing an Existing Shortcut

Locate the existing shortcut (e.g., on the desktop or in a folder).
Right-click the shortcut and select Properties.
In the Shortcut tab, find the Target field. Add the desired options to the end of the existing path. For example:
```
"C:\Path\To\LedFx\ledfx.exe" [options]
```
Click OK to save the changes.
Launch ledfx using the shortcut with the updated options.

Linux

Adding Options via Terminal

Open a terminal.
If ledfx is installed globally, append options to the ledfx command:
```
ledfx [options]
```
If installed in a virtual environment, activate the virtual environment first, then run:
```
source /path/to/venv/bin/activate
ledfx [options]
```

Adding Options to a Desktop Launcher

Creating a New Launcher

Create a .desktop file in ~/.local/share/applications/ (e.g., ledfx-custom.desktop).

Add the following content, replacing [options] with the desired options:

[Desktop Entry]
Name=LedFx Custom Launch
Exec=ledfx [options]
Type=Application
Terminal=true

Save the file and make it executable:

chmod +x ~/.local/share/applications/ledfx-custom.desktop

Launch ledfx from your desktop environment’s application menu with the specified options.

Editing an Existing Launcher

Locate the existing .desktop file, typically in ~/.local/share/applications/.
Open the file with a text editor.
Find the Exec line and append the desired options to the command. For example:
```
Exec=ledfx [options]
```
Save the file and exit the editor.
The launcher will now include the specified options when executed.

macOS

Warning

This section needs updating by those who understand the ways of Mac OS

Adding Options via Terminal

Open the Terminal.
Run the ledfx command with options appended:
```
ledfx [options]
```
If using a virtual environment, activate it first:
```
source /path/to/venv/bin/activate
ledfx [options]
```

Adding Options via Automator Application

Creating a New Automator Application

Open Automator and create a new Application.
Add the Run Shell Script action.
Enter the ledfx command with the desired options:
```
/path/to/ledfx [options]
```
Save the Automator application (e.g., LedFx Custom Launch) to your Applications folder.
Double-click the Automator application to launch ledfx with the specified options.

Editing an Existing Automator Application

Open the Automator application containing your ledfx launch workflow.
Locate the Run Shell Script action and edit the command to include the desired options:
```
/path/to/ledfx [options]
```
Save the changes.
The Automator application will now launch ledfx with the updated options.