CLI and config
The xfea command
Section titled “The xfea command”| Command | What it does |
|---|---|
xfea version |
Print the installed version. |
xfea settings |
Print the current settings. |
xfea meshers |
List the meshing plugins. |
xfea viewers |
List the viewer plugins. |
xfea backends |
List the solver plugins installed here with a valid licence. |
xfea status [FOLDER] |
Print how the solves under FOLDER (default: the current folder) have gone, or are going: one line per run record found. |
xfea status FOLDER --follow |
The same, printed again every few seconds until the solve ends. -f for short. |
Settings
Section titled “Settings”The settings are one object, xfea.settings, read from ~/.xfea/config.json when xfea is imported. The file is
written with the defaults if it does not exist.
from xfea import settings
settings.SOLVER_THREADS = 4 # saved to the file as soon as it is set| Setting | In config.json |
What it is |
|---|---|---|
SOLVER_THREADS |
solver_threads |
Threads a solver runs with when a run does not say. At least 1. |
DEFAULT_VIEWER |
default_viewer |
The viewer plugin used when none is named. |
DEFAULT_DATABASE |
default_database |
The results database plugin used when none is named. |
DEFAULT_ALGORITHM |
default_algorithm |
The meshing plugin set by xfea.apply_configured_defaults(). |
DEFAULT_BACKEND |
default_backend |
The local solver plugin activated by xfea.apply_configured_defaults(). |
Not saved, and back to their defaults in every session: VERBOSE, MESH_VERBOSE, GLOBAL_FRAME, PRECISION.
settings.reset()puts the defaults back and saves them;settings.reset(persist=False)for this session only.xfea.apply_configured_defaults()appliesDEFAULT_BACKENDandDEFAULT_ALGORITHM. It is not called on import, so importing xfea stays quiet when the file names plugins that are not installed. It returns why each default that could not be applied failed.
Environment
Section titled “Environment”| Variable | What it is |
|---|---|
XFEA_API_KEY |
The API key for the conversion service. Without it, the first line of ~/.xfea/api_key is used. |
XFEA_CONVERT_URL |
The address of the conversion service. |
© 2026 Francesco Ranaudo · Text and pictures CC BY 4.0 · Code Elastic License 2.0 · how to reuse them