Skip to content

Latest commit

 

History

History
110 lines (81 loc) · 2.92 KB

README.md

File metadata and controls

110 lines (81 loc) · 2.92 KB

planetql

analyze vulnerabilities in c# project

oclif Version Downloads/week License

Prerequisites

codeql-cli (>= 2.4.3)

Usage

$ npm install -g planetql
$ planetql COMMAND
running command...
$ planetql (-v|--version|version)
planetql/0.9.5 darwin-x64 node-v15.7.0
$ planetql --help [COMMAND]
USAGE
  $ planetql COMMAND
...

Commands

planetql analyze [--file | -f] [--database=] [--format=]

analyze vulnerabilities in c# project. must use after planetql setup, codeQL database has created.

USAGE
  $ planetql analyze [--file | -f] [--database=] [--format=]

OPTIONS
  -d, --database=database   [default: /opt/results/source_db] path to datatabase created after setup
  -f, --file                save result to file
  -h, --help                show CLI help
  --format=(csv|text|json)  [default: text] output format

EXAMPLE
  $ planetql analyze -f --format=csv
  Compiling query plan for /opt/ql/...ql
  Evaluation Done; ...
  Shutting down query evaluator.

See code: src/commands/analyze.ts

planetql help [COMMAND]

display help for planetql

USAGE
  $ planetql help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

planetql setup [--project=] [--database=]

setup c# project before analyzed. creates codeQL database

USAGE
  $ planetql setup [--project=] [--database=]

OPTIONS
  -d, --database=database  [default: /opt/results/source_db] result directory path to store created database
  -h, --help               show command help
  -p, --project=project    [default: /opt/src] c# project path

EXAMPLE
  $ planetql setup
  Cleared database directory /opt/results
  Initializing database at /opt/results
  ...
  Successfully created database at /opt/results

See code: src/commands/setup.ts