Skip to content
dbLinter

help

This command displays the help message for the dbLinter CLI.

Syntax

Section titled “Syntax”
dblinter help

Example

Section titled “Example”
Terminal window
dblinter help

The console output looks like this:

Usage: dblinter [<options>] <command> [<args>]


Options:
  --workspace=<dir>            Working directory for the command.
  --repoUrl=<url>              Repository URL.
  --tenantName=<tenant>        Tenant for authentication.
  --userName=<e-mail>          E-mail address for authentication.
  --accessToken=<token>        Access token for authentication.
  --configName=<config>        Configuration for checks and SQL-based tests.
  --connJdbcUrl=<jdbcUrl>      JDBC URL for read-only database access.
  --connUserName=<user>        JDBC user for read-only database access.
  --connPassword=<password>    JDBC password for read-only database access.
  --logLevel=<level>           Log level (off, error, warning, info, debug, trace).
  --logFile=<logFile>          Name of the log file.
  --logFormat=<format>         Log format (short, ext1, ext2, ext3).
  --clearCacheThreshold=<mb>   ANTLR memory threshold in megabytes.
  --pretty=<boolean>           Pretty print JSON output (true, false).
  --indent=<spaces>            Number of spaces for pretty printing.
  --options=<properties>       Load options from file.


Commands:
  ls                           Start language server.
  check [<args>]               Run static code analysis in current directory.
    --outputFormats=<formats>  Comma-separated list of output formats (vscode,
                               sonarqube, sarif, checkstyle, github, gitlab).
    --outputName=<name>        Base name of the output files.
    --parallel=<n>             Number of files analysed in parallel.
  test [<args>]                Run SQL-based tests.
    --outputFormats=<formats>  Comma-separated list of output formats (vscode,
                               junit).
    --outputName=<name>        Base name of the output files without file extension.
    --parallel=<n>             Number of SQL-based tests executed in parallel.
  gen-java [<args>]            Generate custom validator Java project using Maven.
    --outputName=<name>        Root directory name for the Maven project.
    --tenantFilter=<regEx>     Regular expression to filter tenant names.
    --ruleFilter=<regEx>       Regular expression to filter rule names.
    --groupId=<name>           Group ID for the project (e.g. com.company)
    --packageName=<name>       Root package name for the project (e.g. com.company.dblinter)
  gen-utplsql [<args>]         Generate utPLSQL PL/SQL package for SQL-based tests.
    --outputName=<name>        Base name of the output file(s).
    --specExt=<ext>            Name of the extension of the package specification (.sql, .pks)
    --bodyExt=<ext>            Name of the extension of the package body (.sql, .pkb)
    --packageName=<name>       Name of the PL/SQL package.
    --suitePath=<path>         Name of the utPLSQL suite-path.
  export-tenants [<args>]      Export tenants to a JSON file.
    --outputName=<name>        Name of the output file.
    --tenantFilter=<regEx>     Regular expression to filter tenant names.
    --planFilter=<regEx>       Regular expression to filter plan names (Free,
                               Essential, Professional)
  import-tenants [<args>]      Import tenants from a JSON file.
    --inputName=<name>         Name of the input file.
    --tenantFilter=<regEx>     Regular expression to filter tenant names.
  version                      Show version information.
  help                         Show help message.