┌────────────────────────────────────────────── Help ──────────────────────────────────────────────┐ │Vigil Code Monitor │ │ │ │Vigil shows a list of status reports for a given codebase, and keeps them │ │up to date as the codebase changes. │ │ │ │A set of reports is produced for every file, which depend on the file's type. │ │ │ │A status indicator summarises the state of each report, and a report is viewed │ │by selecting this status indicator with the cursor. The types of status are │ │listed below. │ │ │ │The reports are cached in the codebase's root directory in a ".vigil" directory. │ │ │ │ │ │Usage: │ │ vigil [options] │ │ vigil -h | --help │ │ │ │Example: │ │ # vigil my_project │ │ │ │Options: │ │ -h, --help Show this screen and exit. │ │ -s on|off, --sandbox=on|off Use a sandbox to prevent changes to the │ │ filesystem. The sandbox is on by default. │ │ -w COUNT, --workers=COUNT The number of processes working in parallel. │ │ By default it is twice the number of cpus. │ │ -e "COMMAND", --editor="COMMAND" The command used to start the editor, in │ │ the edit command. It may contain options. │ │ │ │Keys: │ │ h - Show the help screen. (toggle) │ │ q - Quit. │ │ d, c, j, k, f, v or arrow keys or mouse click - Move the cursor. │ │ D, C, J, K, F, V or page up, page down, home, end or the mouse wheel - │ │ Scroll the result pane. │ │ t - Turn the result pane to portrait or landscape orientation. (toggle) │ │ l - Show the activity log. (toggle) │ │ e - Edit the current file with an editor defined by -e, $EDITOR or $VISUAL. │ │ n - Move to the next issue. │ │ N - Move to the next issue of the current tool. │ │ p - Pause workers. (toggle) │ │ o - Order files by type, or by directory location. (toggle) │ │ r - Refresh the currently selected report. │ │ │ │Statuses: │ │   Normal │ │   Ok │ │   Problem │ │   Not applicable │ │   Running │ │   Paused │ │   Timed out │ │ . Pending │ │ E Error │ │ │ │ │ │ │ └──────────────────────────────────────────────────────────────────────────────────────────────────┘