CLI-reference.md

+# List of commands for the EvalAssist CLI
+
+[[_TOC_]]
+
+# evalassist-cli version
+
+`evalassist-cli version [options]`
+
+print the current version
+
+## Options
+- `-h, --help` display help for command
+
+
+# evalassist-cli project
+
+`evalassist-cli project [options] [command]`
+
+to retrieve and manage projects
+
+## Options
+- `-h, --help` display help for command
+
+
+## evalassist-cli project list
+
+`evalassist-cli project list [options]`
+
+List projects from the remote Gitlab host.
+
+### Options
+- `-s, --search <string>` Search for projects containing a specific string in their name or description.
+- `-l, --limit <number>` Specify the limit on the amount of projects to query from the Gitlab host, or -1 to remove the limit.
+- `-m, --membership` Only search projects you are a member of.
+- `-uid, --userID <string>` Search for projects owned by a specific user.
+- `-da, --dateAfter <ISODate>` Search for projects created after a specific date, must be a valid ISO 8601 date string.
+- `-u, --projectURL <string>` Retrieve a single specific project from its URL. Override all other options. Conflicts with '--projectID'.
+- `-id, --projectID <number>` Retrieve a single specific project from its ID. Override all other options. Conflicts with '--projectURL'.
+- `-h, --help` display help for command
+
+
+## evalassist-cli project clone
+
+`evalassist-cli project clone [options]`
+
+Clone projects from the remote Gitlab host. It is advised to first run the "list" command with the desired options.
+
+### Options
+- `-p, --path <string>` Run at path.
+- `-s, --search <string>` Search for projects containing a specific string in their name or description.
+- `-l, --limit <number>` Specify the limit on the amount of projects to query from the Gitlab host, or -1 to remove the limit.
+- `-m, --membership` Only search projects you are a member of.
+- `-uid, --userID <string>` Search for projects owned by a specific user.
+- `-da, --dateAfter <ISODate>` Search for projects created after a specific date, must be a valid ISO 8601 date string.
+- `-u, --projectURL <string>` Retrieve a single specific project from its URL. Override all other options. Conflicts with '--projectID'.
+- `-id, --projectID <number>` Retrieve a single specific project from its ID. Override all other options. Conflicts with '--projectURL'.
+- `-h, --help` display help for command
+
+
+## evalassist-cli project infos
+
+`evalassist-cli project infos [options]`
+
+Get informations on local project(s).
+
+### Options
+- `-p, --path <string>` Run at path.
+- `-r, --recursive` If specified, informations will be provided for all .evalassist directories contained in the directory.
+- `-h, --help` display help for command
+
+
+## evalassist-cli project check-deadline
+
+`evalassist-cli project check-deadline [options] <ISODate>`
+
+Checks if the last commit of a local project was done before the deadline.
+
+### Options
+- `-p, --path <string>` Run at path.
+- `-r, --recursive` If specified, informations will be provided for all .evalassist directories contained in the directory.
+- `-lo, --lateOnly` If specified, output will only be generated in case of a late project.
+- `-h, --help` display help for command
+
+
+## evalassist-cli project update
+
+`evalassist-cli project update [options]`
+
+Update local projects with the latest changes from the remote Gitlab host.
+
+### Options
+- `-p, --path <string>` Run at path.
+- `-r, --recursive` If specified, informations will be provided for all .evalassist directories contained in the directory.
+- `-h, --help` display help for command
+
+
+# evalassist-cli config
+
+`evalassist-cli config [options] [command]`
+
+to manage configurations (Gitlab hostnames and API keys)
+
+## Options
+- `-h, --help` display help for command
+
+
+## evalassist-cli config current
+
+`evalassist-cli config current [options]`
+
+Current configuration.
+
+### Options
+- `-h, --help` display help for command
+
+
+## evalassist-cli config select
+
+`evalassist-cli config select [options] <name>`
+
+Select current configuration.
+
+### Options
+- `-h, --help` display help for command
+
+
+## evalassist-cli config list
+
+`evalassist-cli config list [options]`
+
+List configurations.
+
+### Options
+- `-h, --help` display help for command
+
+
+## evalassist-cli config new
+
+`evalassist-cli config new [options] <name>`
+
+Create new configuration.
+
+### Options
+- `-h, --host <string>` 
+- `--accessToken <string>` 
+- `--help` display help for command
+
+
+## evalassist-cli config set
+
+`evalassist-cli config set [options]`
+
+Overrides current configuration values.
+
+### Options
+- `--name <string>` 
+- `--accessToken <string>` 
+- `--host <string>` 
+- `-h, --help` display help for command
+
+
+# evalassist-cli feedback
+
+`evalassist-cli feedback [options] [command]`
+
+to prepare and send feedbacks on issue trackers
+
+## Options
+- `-h, --help` display help for command
+
+
+## evalassist-cli feedback create
+
+`evalassist-cli feedback create [options] <name>`
+
+Create a feedback file.
+
+### Options
+- `-p, --path <string>` Run at path.
+- `-r, --recursive` If specified, informations will be provided for all .evalassist directories contained in the directory.
+- `-c, --content <string>` Feedback content.
+- `-cf, --contentFilePath <path>` Feedback content from file.
+- `-h, --help` display help for command
+
+
+## evalassist-cli feedback submit
+
+`evalassist-cli feedback submit [options] <name>`
+
+Submit a feedback file.
+
+### Options
+- `-p, --path <string>` Run at path.
+- `-r, --recursive` If specified, informations will be provided for all .evalassist directories contained in the directory.
+- `-t, --title <string>` Feedback title.
+- `-h, --help` display help for command
+
+
+# evalassist-cli evaluation
+
+`evalassist-cli evaluation [options] [command]`
+
+to evaluate projects using external evaluators
+
+## Options
+- `-h, --help` display help for command
+
+
+## evalassist-cli evaluation run
+
+`evalassist-cli evaluation run [options] <evaluationName>`
+
+Evaluate a project using an external evaluator. By default, will both analyze and score the project.
+
+### Options
+- `-p, --path <string>` Run at path.
+- `-r, --recursive` If specified, informations will be provided for all .evalassist directories contained in the directory.
+- `-e, --evaluator <path>` JavaScript evaluator to use. Can be a path to local .js file, or the name of a globally installed NPM module.
+- `-d, --docker <image>` Evaluator in Docker : an image name should be passed
+- `--evaluator-configuration <path>` The YAML configuration file for the evaluator to use. This file could passed volumes and environnements variables by keys volumes and envs
+- `--score-only` Only perform the scoring pass, based on the existing analysis results.
+- `--analyze-only` Only perform the analysis pass, does not compute the score.
+- `--overwrite` Erase any existing evaluation results with the same name.
+- `--update` Erase existing evaluation results with the same name if these previous results were computed for a different commit.
+- `-h, --help` display help for command
+
+
+## evalassist-cli evaluation exportCSV
+
+`evalassist-cli evaluation exportCSV [options] <evaluationName>`
+
+Generate an evaluation CSV from a set of projects that have previously been evaluated.
+
+### Options
+- `-p, --path <string>` Run at path.
+- `-r, --recursive` If specified, informations will be provided for all .evalassist directories contained in the directory.
+- `-o, --output <path>` Path of the exported CSV.
+- `--per-member` Export a per-member CSV.
+- `--per-project` Export a per-project CSV.
+- `--overwrite` Erase any exising output file with the same name.
+- `--hide-members <string...>` Hide specific members from projects members lists (eg. bots).
+- `-h, --help` display help for command
+
+
+## evalassist-cli evaluation infos
+
+`evalassist-cli evaluation infos [options]`
+
+Get informations on performed evaluations.
+
+### Options
+- `-p, --path <string>` Run at path.
+- `-r, --recursive` If specified, informations will be provided for all .evalassist directories contained in the directory.
+- `-h, --help` display help for command
+
+
+## evalassist-cli evaluation rm
+
+`evalassist-cli evaluation rm [options] <evaluationName>`
+
+Delete evaluation data.
+
+### Options
+- `-p, --path <string>` Run at path.
+- `-r, --recursive` If specified, informations will be provided for all .evalassist directories contained in the directory.
+- `-h, --help` display help for command
\ No newline at end of file