Command Line Interface

makex

Makex command line program.

See https://meta.company/go/makex for the latest documentation.

usage: ... [-h] [--verbose] [--debug] [--color {off,auto,on}]
            [--cache CACHE] [--python-audit [PYTHON_AUDIT]]
            {run,path,dot,affected,inputs,outputs,evaluate,tasks,targets,completions,workspace,complete,version}
            ...

-h, --help

show this help message and exit

--verbose

Verbosity of makex messaging. Specify multiple times or set to a number between 0 and 3. (The default is 0 and the maximum is 3).

--debug

Enable debug and logging to the maximum level.

--color {off,auto,on}

Print colored messaging.

--cache <cache>

The unified external cache/build path.

--python-audit <python_audit>

Enable auditing of python audit hooks. Pass a identifier. May be passed multiple times.

Note

At the moment, the global flags must be specified AFTER the [sub]command.

Note

Makex installs a copy of itself with the alias mx.

Commands

Makex has several commands.

makex run

Run a task or list of tasks.

usage: makex run [-h] [--python-audit [PYTHON_AUDIT]] [--directory DIRECTORY]
                 [--force] [--dry] [--cpus CPUS]
                 tasks [tasks ...]

tasks

-h, --help

show this help message and exit

--python-audit <python_audit>

Enable auditing of python audit hooks. Pass a identifier. May be passed multiple times.

--directory <directory>

Change to directory before evaluating tasks.

--force

Always run all task even if they don’t need to be.

--dry

Do a dry run. Nothing will be executed.

--cpus <cpus>

Worker cpus to spawn for running/evaluating tasks in parallel. (Default: None)

makex tasks

usage: makex tasks [-h] [--python-audit [PYTHON_AUDIT]]
                   [--paths {absolute,workspace,relative,None}] [--prefix]
                   [path]

path

Path to a makex file or directory. The current directory is the default.

-h, --help

show this help message and exit

--python-audit <python_audit>

Enable auditing of python audit hooks. Pass a identifier. May be passed multiple times.

--paths {absolute,workspace,relative,None}

Path to a makex file or directory

--prefix

makex path

Get the output path of a task.

usage: makex path [-h] [--python-audit [PYTHON_AUDIT]] [--real] task

task

Name and optional path of a task. //path:name, //:name, :name are all valid.

-h, --help

show this help message and exit

--python-audit <python_audit>

Enable auditing of python audit hooks. Pass a identifier. May be passed multiple times.

--real

Return cache path. This may be slower as it must resolve Workspaces.

makex workspace

Print the current workspace, or the workspace detected at path.

usage: makex workspace [-h] [--python-audit [PYTHON_AUDIT]] [path]

path

Path representing a workspace, or inside a workspace.

-h, --help

show this help message and exit

--python-audit <python_audit>

Enable auditing of python audit hooks. Pass a identifier. May be passed multiple times.

makex completions

Generate completion files for shells.

usage: makex completions [-h] [--python-audit [PYTHON_AUDIT]]
                         [--shell {bash,zsh}] [--internal]
                         [file]

file

The output file to write the completions to. If not specified, will the completion will be written to standard out.

-h, --help

show this help message and exit

--python-audit <python_audit>

Enable auditing of python audit hooks. Pass a identifier. May be passed multiple times.

--shell {bash,zsh}

--internal