Remake CLI¶

remake command line tool

usage: remake [-h] [--debug | --info | --warning] [--debug-exception] [--no-colour]
              {run,run-tasks,ls-rules,ls-tasks,ls-files,rm-files,info,rule-info,task-info,file-info,monitor,setup-examples,version}
              ...

Positional Arguments¶

subcmd_name: Possible choices: run, run-tasks, ls-rules, ls-tasks, ls-files, rm-files, info, rule-info, task-info, file-info, monitor, setup-examples, version

Named Arguments¶

--debug, -D

Enable debug logging

Default: False

--info, -I

Enable info logging

Default: False

--warning, -W

Warning logging only

Default: False

--debug-exception, -X

Launch pdb/ipdb on exception

Default: False

--no-colour, -B

Black and white logging

Default: False

Sub-commands:¶

run¶

Run all pending tasks

remake run [-h] [--rescan-only] [--one] [--random] [--force] [--reasons] [--executor EXECUTOR]
           [--display {print_status,task_dag}]
           [remakefile]

Positional Arguments¶

remakefile: Default: “remakefile”

Named Arguments¶

--rescan-only

only rescan input files

Default: False

--one, -o

run one pending task

Default: False

--random

run one (lucky dip!)

Default: False

--force, -f

Default: False

--reasons, -r

Default: False

--executor, -E

Default: “singleproc”

--display, -d

Possible choices: print_status, task_dag

run-tasks¶

Run specified tasks (uses same flags as ls-tasks)

remake run-tasks [-h] [--tasks [TASKS ...]] [--handle-dependencies] [--force] [--reasons]
                 [--executor EXECUTOR] [--display {print_status,task_dag}] [--filter FILTER]
                 [--rule RULE] [--requires-rerun] [--uses-file USES_FILE]
                 [--produces-file PRODUCES_FILE] [--ancestor-of ANCESTOR_OF]
                 [--descendant-of DESCENDANT_OF]
                 [remakefile]

Positional Arguments¶

remakefile: Default: “remakefile”

Named Arguments¶

--tasks, -t
--handle-dependencies, -H: Default: False
--force, -f: Default: False
--reasons, -r: Default: False
--executor, -E: Default: “singleproc”
--display, -d: Possible choices: print_status, task_dag
--filter
--rule
--requires-rerun, -R: Default: False
--uses-file, -U
--produces-file, -P
--ancestor-of, -A: includes requested task
--descendant-of, -D: includes requested task

ls-rules¶

List rules

remake ls-rules [-h] [--long] [--filter FILTER] [--uses-file USES_FILE] [--produces-file PRODUCES_FILE]
                [remakefile]

Positional Arguments¶

remakefile: Default: “remakefile”

Named Arguments¶

--long, -l: Default: False
--filter, -F
--uses-file, -U
--produces-file, -P

ls-tasks¶

List tasks

remake ls-tasks [-h] [--long] [--filter FILTER] [--rule RULE] [--requires-rerun]
                [--uses-file USES_FILE] [--produces-file PRODUCES_FILE] [--ancestor-of ANCESTOR_OF]
                [--descendant-of DESCENDANT_OF]
                [remakefile]

Positional Arguments¶

remakefile: Default: “remakefile”

Named Arguments¶

--long, -l: Default: False
--filter
--rule
--requires-rerun, -R: Default: False
--uses-file, -U
--produces-file, -P
--ancestor-of, -A: includes requested task
--descendant-of, -D: includes requested task

ls-files¶

List files

remake ls-files [-h] [--long] [--input | --output | --input-only | --output-only | --inout]
                [--produced-by-rule PRODUCED_BY_RULE] [--used-by-rule USED_BY_RULE]
                [--produced-by-task PRODUCED_BY_TASK] [--used-by-task USED_BY_TASK] [--exists]
                [remakefile]

Positional Arguments¶

remakefile: Default: “remakefile”

Named Arguments¶

--long, -l: Default: False
--input: Default: False
--output: Default: False
--input-only: Default: False
--output-only: Default: False
--inout: Default: False
--produced-by-rule
--used-by-rule
--produced-by-task
--used-by-task
--exists: Default: False

rm-files¶

Remove files

remake rm-files [-h] [--force] [--input | --output | --input-only | --output-only | --inout]
                [--produced-by-rule PRODUCED_BY_RULE] [--used-by-rule USED_BY_RULE]
                [--produced-by-task PRODUCED_BY_TASK] [--used-by-task USED_BY_TASK]
                [remakefile]

Positional Arguments¶

remakefile: Default: “remakefile”

Named Arguments¶

--force, -f: Default: False
--input: Default: False
--output: Default: False
--input-only: Default: False
--output-only: Default: False
--inout: Default: False
--produced-by-rule
--used-by-rule
--produced-by-task
--used-by-task

info¶

Information about remakefile status

remake info [-h] [--short | --long] [--display {print_status,task_dag}] [remakefile]

Positional Arguments¶

remakefile: Default: “remakefile”

Named Arguments¶

--short, -s

Default: False

--long, -l

Default: False

--display, -d

Possible choices: print_status, task_dag

Default: “print_status”

rule-info¶

Information about rule

remake rule-info [-h] [--long] [remakefile] [rules ...]

Positional Arguments¶

remakefile: Default: “remakefile”
rules

Named Arguments¶

--long, -l: Default: False

task-info¶

Information about task

remake task-info [-h] [--long] [remakefile] [tasks ...]

Positional Arguments¶

remakefile: Default: “remakefile”
tasks

Named Arguments¶

--long, -l: Default: False

file-info¶

Information about file

remake file-info [-h] [--long] [remakefile] [filenames ...]

Positional Arguments¶

remakefile: Default: “remakefile”
filenames

Named Arguments¶

--long, -l: Default: False

monitor¶

Monitor remake (polls remake metadata dir)

remake monitor [-h] [--timeout TIMEOUT] [remakefile]

Positional Arguments¶

remakefile: Default: “remakefile”

Named Arguments¶

--timeout, -t

timeout (s) to use for polling

Default: 10

setup-examples¶

Setup examples directory

remake setup-examples [-h] [--force]

Named Arguments¶

--force, -f: Default: False

version¶

Print remake version

remake version [-h] [--long]

Named Arguments¶

--long, -l

long version

Default: False

Quickstart Python API