Skip to Content
CLICommands

Commands

Basic Syntax

inkog [OPTIONS] [PATH]

The PATH argument specifies the file or directory to scan. Defaults to the current directory (.).

Flags

FlagTypeDefaultDescription
-pathstring.Source path to scan (file or directory)
-serverstringhttps://inkog-api.fly.devInkog server URL
-outputstringtextOutput format: json, text, html
-severitystringlowMinimum severity: critical, high, medium, low
-verbosebooleanfalseEnable detailed debug output
-versionbooleanfalseShow version and exit
-helpbooleanfalseShow help message

Examples

Basic Scan

# Scan current directory inkog . # Scan specific directory inkog ./src/agents # Scan single file inkog ./agent.py

Output Formats

# JSON output (for CI/CD) inkog -output json . # HTML report inkog -output html . > report.html # Text output (default) inkog -output text .

Severity Filtering

# Only critical and high findings inkog -severity high . # Only critical findings inkog -severity critical . # All findings (default) inkog -severity low .

Debug Mode

# Verbose output for debugging inkog -verbose .

Custom Server

# Use self-hosted server inkog -server https://inkog.internal.company.com .

Exit Codes

CodeMeaning
0Success - No security findings
1Findings detected - Scan completed with issues
2Error - Scan execution failed

Use exit codes for CI/CD pipeline control:

inkog -severity high . || exit 1

Supported File Types

Inkog scans the following file types:

Code:

  • Python (.py)
  • JavaScript (.js)
  • TypeScript (.ts, .tsx)
  • Go (.go)
  • Java (.java)
  • Ruby (.rb)
  • PHP (.php)
  • C# (.cs)
  • Rust (.rs)

Configuration:

  • YAML (.yaml, .yml)
  • JSON (.json)
  • Environment files (.env)
  • Config files (.conf, .cfg)

Skipped Files

The following are automatically skipped:

Build/Dependencies:

  • node_modules/
  • vendor/
  • .git/
  • __pycache__/
  • .venv/, venv/
  • dist/, build/
  • .next/, .nuxt/

Package Files:

  • package.json, package-lock.json
  • yarn.lock, pnpm-lock.yaml
  • go.mod, go.sum
  • Cargo.toml, Cargo.lock
  • Gemfile, Gemfile.lock

Config Files:

  • .eslintrc, .prettierrc
  • babel.config.json
  • webpack.config.js
  • jest.config.js
Last updated on