Running Scripts from the Command-Line

Foxel can execute a script directly from the command line.

Use this to automate tasks or integrate Foxel into external workflows.

Command Format

Run Foxel with the -run argument:

path\to\Foxel.exe -run scriptname

The script argument can be one of the following:

• The name of a shared script as it appears in Foxel.
• The full path to a .lua script file.

Shared script names are matched case-insensitively.

Examples

Run a shared script:

C:\Program Files\Foxel\Foxel.exe -run MyScript

Run a script from a file path:

C:\Program Files\Foxel\Foxel.exe -run "C:\Scripts\MyScript.lua"

Behavior

When started in command-line mode, Foxel opens, executes the script, and then closes automatically after the script finishes.

A window and rendering context are still created, which allows scripts to perform operations that require them.

Exit Codes

Foxel returns the following exit codes:

• 0 — Script executed successfully.
• 102 — Script file was not found.
• 902 — Script execution failed.

These exit codes can be used in batch files, build pipelines, or other automated workflows.

Example Script

This example writes a message to the log:

FxLog = require "FxLog"
FxLog.WriteTrace("Hello World!")