Docs
Welcome to the Falcn documentation. Everything you need to secure your software supply chain.
- 🚀Quick Start Get up and running with Falcn in under 60 seconds.
- 📦 Installation Detailed installation guides for all platforms.
- ⚙️ Configuration Configure Falcn for your specific environment.
- 🏗️ Architecture Deep dive into system design and components.
- 🔗 CI/CD Integration GitHub Actions, GitLab CI, Jenkins and more.
- 📡 API Reference Complete REST API documentation.
Detection Algorithms
Learn how Falcn detects supply chain threats using multiple specialized algorithms:
| Algorithm | Full Name | Purpose |
|---|---|---|
| RUNT | Registry Uncover Naming Threats | Typosquatting detection using string similarity |
| DIRT | Dependency Intelligence Risk Tracker | Business risk assessment based on package metadata |
| GTR | Graph Threat Recognition | Dependency graph analysis for suspicious patterns |
Advanced Topics
- System Architecture & Diagrams — Component overview and data flow
- Security Model — Trust boundaries and threat model
- Performance Tuning — Optimization for CI/CD pipelines
- Policy Engine — Configure BLOCK/ALERT/REVIEW thresholds
- Ollama Setup — Local AI for threat explanations
Quick Install
# Install Falcn
curl -sSL https://falcn.io/install | sh
# Scan your project
falcn scan .
# Enable AI explanations (optional)
export FALCN_LLM_ENABLED=true
falcn scan .💡 New to Falcn?
Start with our Quick Start Guide to scan your first project in under 60 seconds. No configuration required!
Popular Questions
- What are the system requirements?
- How do I set up local AI?
- How do I integrate with GitHub Actions?
- Can Falcn run in air-gapped environments?
- How fast is Falcn in CI/CD?
🌟 Open Source
Falcn is MIT licensed and free forever. Star us on GitHub and join the community!