Configuring Codyze

There are two ways of configuring Codyze, through command line options or a configuration file.

If both are present, the command line options take precedence over the configuration file. For list and map type options, the data from the configuration file can be overwritten if the normal option (e.g. --option-name) is used. To append the data from the command line to the one from the configuration file, use the additions option (e.g. --option-name-additions)

Command Line Interface¶

There are three execution modes in which Codyze can run:

• Command line mode:
  Non-interactive command line client, accepts arguments from command line and runs analysis
• Language server protocol mode:
  This mode is for IDE support and binds to stdout as a server for Language Server Protocol (LSP)
• Interactive console mode:
  The text based user interface (TUI) is an interactive console that allows exploring the analyzed source code by manual queries

Subcommands are used to enter the modes (analyze, lsp, or interactive).

The help and version message can be displayed with -h and -V respectively. The full help is only available if a subcommand is specified.

Configuration File¶

The configurations can also be defined with a JSON configuration file. Use the option --config=<filepath> to specify the path to the config file. The configuration from ./codyze.json will always be loaded if no other file is specified.

Relative paths in the configuration file are resolved relative to the configuration file location.

The configuration structure separates the options by subcommand as seen below.

{
  "analyze": {
    "source": "src"
  },
  "lsp": {
    "source": "other-src"
  }
}

List of Configurations¶

This is a list of all available configurations, their descriptions and their respective name. The names are the same for the configuration file and the CLI options.

./ denotes the working directory in which Codyze was started.