CLI & SDK

INSTALLATION

No global install needed. Run directly with npx:

npx wardek scan https://example.com

Or install globally for repeated use:

npm install -g wardek

API KEY CONFIGURATION

Set your API key as an environment variable. The CLI reads from WARDEK_API_KEY automatically.

# Set for current session
export WARDEK_API_KEY="ssk_live_your_api_key_here"

# Or pass inline
WARDEK_API_KEY="ssk_live_..." npx wardek scan https://example.com

# Or add to .env
echo 'WARDEK_API_KEY=ssk_live_...' >> .env

USAGE

Basic scan

npx wardek scan https://example.com

# Output:
# WARDEK SECURITY SCAN
# Target: https://example.com
# Score:  87/100 [B+]
# ─────────────────────
# Headers     ██████████░░  82%
# SSL         ████████████  100%
# Cookies     ████████░░░░  67%
# CORS        ████████████  100%
# ...

View scan history

npx wardek scans --limit 10

Export results

# JSON export
npx wardek export <scan-id> --format json > report.json

# YAML export
npx wardek export <scan-id> --format yaml > report.yaml

Fail on threshold (CI/CD)

# Exit code 1 if score < 75
npx wardek scan https://example.com --min-score 75

# Fail on any critical finding
npx wardek scan https://example.com --fail-on-critical

CLI OPTIONS

TYPESCRIPT SDK

A typed client library for seamless integration into Node.js and TypeScript projects. Subscribe to the changelog for release announcements.

Preview

import { WarDek } from '@wardek/sdk';

const client = new WarDek({
  apiKey: process.env.WARDEK_API_KEY!,
});

// Launch a scan
const scan = await client.scan('https://myapp.com');
logger.info(scan.score);  // 87
logger.info(scan.grade);  // "B+"

// List recent scans
const { scans } = await client.listScans({ limit: 5 });

// Export results
const json = await client.export(scan.id, 'json');
const yaml = await client.export(scan.id, 'yaml');

// CI/CD helper
const passed = scan.score >= 75 && !scan.hasCritical;
process.exit(passed ? 0 : 1);