Documentation

Learn how to use CyRook to secure your web applications and APIs

Quick Start

Get started with CyRook in minutes

1. Create an Asset

Add your website or API endpoint to start scanning. Go to Assets and click "Add Asset".

2. Run a Scan

Start a security scan from the Scans page. Choose between External, API, or Frontend scan types.

3. Review Findings

Check your security findings in the Findings page. Filter by severity and fix issues.

Security Scanning

Comprehensive security scans for TLS, headers, cookies, CORS, and more

  • • External web scanning
  • • API security testing
  • • Frontend secret detection
  • • Real-time results

Baselines & Regression

Track security posture changes and detect regressions automatically

  • • Security posture snapshots
  • • Regression detection
  • • Baseline management
  • • Change tracking

Auto-Fix PRs

Automatically generate pull requests with security fixes

  • • Stack-aware templates
  • • Next.js, Nginx, Express
  • • Automated PR creation
  • • GitHub integration

CI/CD Integration

Integrate security scans into your CI/CD pipeline

  • • GitHub Actions
  • • Policy enforcement
  • • CI gating
  • • Zero-config setup

Integrations

Connect with Slack, Jira, and GitHub

  • • Slack alerts
  • • Jira issue creation
  • • GitHub repository linking
  • • Real-time notifications

CLI Tool

Command-line interface for automation

  • • Scan management
  • • Asset operations
  • • Finding queries
  • • CI/CD automation

API Reference

Complete API documentation with interactive Swagger UI

Explore all API endpoints, request/response formats, and authentication methods.

Open API Documentation

CLI Documentation

Command-line tool for managing CyRook

Installation

npm install -g cyrook-cli

Quick Commands

cyrook scan create -t https://example.com
cyrook finding list --severity CRITICAL
cyrook asset list
View CLI Docs

Guides

Step-by-step guides for common tasks

Need Help?

Get support from our team