Appendix: CLI syntax reference

Examples:

An example of a command using most parameters:
java -jar RepoSense.jar --repos https://github.com/reposense/RepoSense.git --output ./report_folder --since 31/1/2017 --until 31/12/2018 --formats java adoc xml --view --ignore-standalone-config --last-modified-date --timezone UTC+08

Same command as above but using most parameters in alias format:
java -jar RepoSense.jar -r https://github.com/reposense/RepoSense.git -o ./report_folder -s 31/1/2017 -u 31/12/2018 -f java adoc xml -v -i -l -t UTC+08

The section below provides explanations for each of the flags.

--assets, -a

--config, -c

--formats, -f

--formats LIST_OF_FORMATS: Specifies which file extensions to be included in the analysis.

• Parameter: LIST_OF_FORMATS A space-separated list of file extensions that should be included in the analysis.
  Default: all file formats
• Alias: -f
• Example:--formats css fxml gradle or -f css fxml gradle

--help, -h

--help: Shows the help message.

• Alias: -h

Cannot be used with any other flags.

--ignore-standalone-config, -i

--ignore-standalone-config: Specifies that the standalone config file in the repo should be ignored.

• Default: the standalone config file is not ignored
• Alias: -i
• Example:--ignore-standalone-config or -i

This flag overrides the Ignore standalone config field in the CSV config file.

--last-modified-date, -l

--last-modified-date: Specifies that the last modified date of each line of code should be added to authorship.json.

• Default: the last modified date of each line of code will not be added to authorship.json
• Alias: -l (lowercase L)
• Example:--last-modified-date or -l

The last modified dates will be in the same timezone specified with the --timezone flag.

--output, -o

--output OUTPUT_DIRECTORY: Indicates where to save the report generated.

• Parameter: OUTPUT_DIRECTORY The location for the generated reposense-report folder.
  Default: current directory
• Alias: -o
• Example: --output ./foo or -o ./foo (the report will be in the ./foo/reposense-report folder)

--period, -p

--period PERIOD: Specifies the period of analysis window.

• Parameter: PERIOD The period of analysis window, in the format nd (for n days) or nw (for n weeks). It is used to calculate end date if only start date is specified, or calculate end date if only start date is specified.
• Alias: -p
• Example: --period 30d or --period 4w

• If both start date and end date are not specified, the date of generating the report will be taken as the end date.
• Cannot be used with both --since and --until.

--repos, -r

--repos REPO_LOCATION: Specifies which repositories to analyze.

• Parameter: REPO_LOCATION A list of URLs or the disk location of the git repositories to analyze, separated by spaces.
• Alias: -r
• Examples:
  • --repos https://github.com/reposense/RepoSense.git
  • --repos https://github.com/reposense/RepoSense.git c:/myRepose/foo/bar: analyzes the two specified repos (one remote, one local) and generates one report containing details of both.

Cannot be used with --config.

--since, -s

--since START_DATE: Specifies the start date for the period to be analyzed.

• Parameter: START_DATE The first day of the period to be analyzed, in the format DD/MM/YYYY.
  Default: one month before the current date
• Alias: -s
• Example:--since 21/10/2017 or -s 21/10/2017

• If the start date is not specified, only commits made one month before the end date (if specified) or the date of generating the report, will be captured and analyzed.
• If d1 is specified as the start date (--since d1 or -s d1), then the earliest commit date of all repositories will be taken as the since date.

--timezone, -t

--timezone ZONE_ID: Indicates the timezone to be used for the analysis.

• Parameter: ZONE_ID The timezone in the format ZONE_ID[±hh[mm]].
  Default: system's default timezone
• Alias: -t
• Example:--timezone UTC+08 or -t UTC-1030

--until, -u

--until END_DATE: Specifies the end date of the analysis period.

• Parameter: END_DATE The last date of the period to be analyzed, in the format DD/MM/YYYY.
  Default: current date
• Alias: -u
• Example:--until 21/10/2017 or -u 21/10/2017

Note: If the end date is not specified, the date of generating the report will be taken as the end date.

--version, -V

--version: Shows the version of RepoSense.

• Alias: -V (upper case)

Cannot be used with any other flags.

--view, -v

--view [REPORT_FOLDER]: Specifies that the report should be opened in the default browser.

• Parameter: REPORT_FOLDER Optional. If specified, no analysis will be performed and the report specified by the argument will be opened.
  Default: ./reposense-report
• Alias: -v
• Example:--view or -v