/idefix_cli

A CLI helper tool for Idefix

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

PyPI Documentation Status pre-commit.ci status Ruff

idefix_cli

idefix_cli is a command line utility belt for Idefix.

It defines a idfx command familly. The builtin command set (idfx conf, idfx run, ...) can be extended to include arbitrary helper scripts.

Installation

idefix_cli is distributed via the Python Packaging Index (PyPI).

It is recommended to install this tool at the system level, but still in isolation, using for instance uv as

$ uv tool install 'idefix-cli[isolated]'

or pipx

$ pipx install 'idefix-cli[isolated]'

(adding [isolated] has the effect of pinning dependencies, but is optional)

Otherwise, the most portable way to install the latest stable version is

$ python -m pip install --user idefix_cli

Note that most idfx commands explicitly require that the env variable $IDEFIX_DIR be set at runtime.

Get help

Get a complete description of available commands with

$ idfx --help

Likewise, get help for each command therein as, for instance

$ idfx run --help

For more, read the documentation !