cyrook-cli

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

Installation

``bash
npm install -g cyrook-cli
`

Quick Start

$3

`bash


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).

$3

`bash


Create a scan

cyrook scan create -t https://example.com

Check scan status

cyrook scan status

View scan logs

cyrook scan logs
`

Commands

$3

`bash


Create a new scan

cyrook scan create -t [-m external|api|frontend] [-e production|staging]

List all scans

cyrook scan list

Get scan status

cyrook scan status

View scan logs

cyrook scan logs
`

$3

`bash


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
`

$3

`bash


List all findings

cyrook finding list

Filter by severity

cyrook finding list --severity CRITICAL

Filter by asset

cyrook finding list --asset-id

Show only regressions

cyrook finding list --regressions-only

Get finding details

cyrook finding get
`

$3

`bash


Interactive setup

cyrook config setup

Set API key

cyrook config set-api-key

Set organization ID

cyrook config set-org-id

Set API URL (optional)

cyrook config set-api-url

Show current config

cyrook config show
`

CI/CD Integration

$3

`yaml
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
`

$3

`yaml
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:

`bash
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

- 📖 Documentation
- 💬 Discord Community
- 📧 Email Support
- 🐛 Report Issues

License

MIT License - see LICENSE for details.

---

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