The basic form for invoking the CLI is the following:
# ./tuleap.php [program options] [module name] [function name]
[function parameters]
Program options:
-v : Verbose. Give a detailed output of what’s going on.
-h: Help. Display help on how to use the program.
--retry N: Retry operation N times (Default: 0). If API call fails due to a network issue, re-issue call until it succeeds or at max N times. This option is safe with Read actions (get) but use it carefully with write (add/update/delete) ones.
Module name: A "module" is a grouping of functions that act over a specific part of the Tuleap system. Currently, the following modules are available:
(none): If the module is empty, system-wide functions are accesible (i.e., login to the server)
tracker: Tracker management module
frs : File releases management module
docman : Documents management module
Function name: The name of the function to invoke depends on the module being called. For details, see Chapter 3.
Function parameters: The parameters also depend on the function being called. See Chapter 3.
 | NOTE: the accentuated letters are not supported in the CLI. |
| NOTE: a star (*) near a command argument means the argument is mandatory. For instance getArtifacts --tracker_id* means you have to provides a --tracker_id parameter to getArtifacts command. |