Package Exports

cyrook-cli
cyrook-cli/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cyrook-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cyrook-cli

Official command-line interface for CyRook - Developer-first web & API security scanning platform.

Installation

npm install -g cyrook-cli

Quick Start

1. Configure Your CLI

# Interactive setup wizard
cyrook config setup

# Or set manually
cyrook config set-api-url https://api.cyrook.com
cyrook config set-api-key YOUR_API_KEY
cyrook config set-org-id YOUR_ORG_ID

Note: API keys are required for CLI access. Get your API key from your CyRook dashboard (Pro plan required).

2. Run Your First Scan

# Create a scan
cyrook scan create -t https://example.com

# Check scan status
cyrook scan status <scan-id>

# View scan logs
cyrook scan logs <scan-id>

Commands

Scans

# Create a new scan
cyrook scan create -t <url> [-m external|api|frontend] [-e production|staging]

# List all scans
cyrook scan list

# Get scan status
cyrook scan status <scan-id>

# View scan logs
cyrook scan logs <scan-id>

Assets

# Create an asset
cyrook asset create -n "My App" -t https://example.com [-y WEB|API]

# List all assets
cyrook asset list

# Get asset details
cyrook asset get <asset-id>

Findings

# List all findings
cyrook finding list

# Filter by severity
cyrook finding list --severity CRITICAL

# Filter by asset
cyrook finding list --asset-id <asset-id>

# Show only regressions
cyrook finding list --regressions-only

# Get finding details
cyrook finding get <finding-id>

Configuration

# Interactive setup
cyrook config setup

# Set API key
cyrook config set-api-key <key>

# Set organization ID
cyrook config set-org-id <id>

# Set API URL (optional)
cyrook config set-api-url <url>

# Show current config
cyrook config show

CI/CD Integration

GitHub Actions

name: Security Scan
on: [push]

jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      
      - name: Install CyRook CLI
        run: npm install -g @cyrook/cli
      
      - name: Configure CLI
        run: |
          cyrook config set-api-key ${{ secrets.CYROOK_API_KEY }}
          cyrook config set-org-id ${{ secrets.CYROOK_ORG_ID }}
      
      - name: Run Security Scan
        run: cyrook scan create -t https://staging.example.com -e staging

GitLab CI

security_scan:
  stage: test
  script:
    - npm install -g @cyrook/cli
    - cyrook config set-api-key $CYROOK_API_KEY
    - cyrook config set-org-id $CYROOK_ORG_ID
    - cyrook scan create -t https://staging.example.com

Environment Variables

You can also configure the CLI using environment variables:

export CYROOK_API_URL=https://api.cyrook.com
export CYROOK_API_KEY=your_api_key
export CYROOK_ORG_ID=your_org_id

cyrook scan list

Features

🚀 Fast & Efficient - Optimized for CI/CD pipelines
🔒 Secure - API key-based authentication
📊 Real-time Results - Live scan progress and results
🎯 Filtering - Filter findings by severity, asset, and more
🔄 Regression Detection - Track security posture changes
📝 Detailed Logs - Full scan execution logs
⚙️ Configurable - Flexible configuration options

Requirements

Node.js 18+
CyRook account (sign up at cyrook.com)
Pro plan (for API key access)

Support

License

MIT License - see LICENSE for details.

Made with ♟️ by CyRook - Chess-inspired cybersecurity for modern applications.