Documentation
Welcome to the CodePosture documentation. Here you'll find comprehensive guides and documentation to help you start working with CodePosture as quickly as possible.
Quick Start
Follow these steps to integrate CodePosture with your project in minutes.
1. Install the CLI
npm install -g @codeposture/cli
2. Authenticate
codeposture login
3. Initialize your project
codeposture init
4. Run your first scan
codeposture scan
Installation
CodePosture can be installed via npm, yarn, or as a standalone binary.
npm
npm install -g @codeposture/cli
yarn
yarn global add @codeposture/cli
curl (Linux/macOS)
curl -fsSL https://get.codeposture.tech | sh
Risk Scoring
CodePosture uses a comprehensive risk scoring algorithm that considers multiple factors to prioritize vulnerabilities.
Scoring Factors
- CVSS Score - Common Vulnerability Scoring System base score
- EPSS Score - Exploit Prediction Scoring System probability
- Reachability - Is the vulnerable code path actually used?
- Context - Production vs development, public vs internal
API Authentication
All API requests require authentication using an API key.
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.codeposture.tech/v1/scan