QuillShield CLI

Smart contract security auditing from the command line.

Installation

npm install -g quillshield

Quick Start

# Audit a project
quillshield audit ./my-project

# Audit a single file
quillshield audit ./contracts/Token.sol

Commands

| Command | Description | |---------|-------------| | quillshield audit <path> | Run security audit | | quillshield status <id> | Check audit status | | quillshield report <id> | View audit report | | quillshield config | Configure CLI |

Audit Options

quillshield audit <path> [options]

Options:
  -t, --type <type>   Analysis type (holistic, full, raw)
  -n, --name <name>   Project name
  -w, --wait          Wait for completion (default)
  --no-wait           Don't wait for completion

Analysis Types

| Type | Description | |------|-------------| | holistic | Comprehensive analysis (default) | | full | Standard analysis | | raw | Basic structure analysis |

Supported Projects

• Foundry - Detected by foundry.toml
• Hardhat - Detected by hardhat.config.js
• Truffle - Detected by truffle-config.js
• Raw Solidity - Single .sol files or folders

Configuration

Environment Variables

QUILLSHIELD_API_URL=https://your-backend-url
QUILLSHIELD_ANALYSIS_TYPE=holistic

Config Command

quillshield config --show          # View config
quillshield config --url <url>     # Set API URL

Examples

# Default audit (holistic)
quillshield audit ./my-foundry-project

# Standard analysis
quillshield audit ./my-project --type full

# Quick audit without waiting
quillshield audit ./my-project --no-wait

# Check status later
quillshield status <project-id>

# Get report
quillshield report <project-id>
quillshield report <project-id> --format json --output report.json

License

MIT