Commands
Basic Syntax
inkog [OPTIONS] [PATH]The PATH argument specifies the file or directory to scan. Defaults to the current directory (.).
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
-path | string | . | Source path to scan (file or directory) |
-server | string | https://inkog-api.fly.dev | Inkog server URL |
-output | string | text | Output format: json, text, html |
-severity | string | low | Minimum severity: critical, high, medium, low |
-verbose | boolean | false | Enable detailed debug output |
-version | boolean | false | Show version and exit |
-help | boolean | false | Show help message |
Examples
Basic Scan
# Scan current directory
inkog .
# Scan specific directory
inkog ./src/agents
# Scan single file
inkog ./agent.pyOutput 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
| Code | Meaning |
|---|---|
0 | Success - No security findings |
1 | Findings detected - Scan completed with issues |
2 | Error - Scan execution failed |
Use exit codes for CI/CD pipeline control:
inkog -severity high . || exit 1Supported 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.jsonyarn.lock,pnpm-lock.yamlgo.mod,go.sumCargo.toml,Cargo.lockGemfile,Gemfile.lock
Config Files:
.eslintrc,.prettierrcbabel.config.jsonwebpack.config.jsjest.config.js
Last updated on