Integrations
Integrate Alprina into your development workflow with support for popular tools and platforms.
Available Integrations
CI/CD Platforms
- GitHub Actions - Automate security scans in GitHub workflows
- GitLab CI/CD - Integrate with GitLab pipelines
- Jenkins - Add security scanning to Jenkins builds
- CircleCI - Run Alprina in CircleCI workflows
- Azure DevOps - Integrate with Azure Pipelines
IDEs & Editors
- VS Code - Real-time security analysis in VS Code
- JetBrains IDEs - PyCharm, IntelliJ, WebStorm integration
- Vim/Neovim - Command-line integration for Vim users
Version Control
- Pre-commit Hooks - Scan code before commits
- Git Hooks - Automate scans with Git events
Project Management
- Jira - Create tickets from security findings
- Linear - Sync findings to Linear issues
- Slack - Receive scan notifications in Slack
API Integration
- REST API - Direct API access
- Python SDK - Python library
- JavaScript SDK - Node.js/Browser library
Quick Start
Most integrations follow this pattern:
-
Install Alprina CLI
pip install alprina-cli -
Configure Authentication
alprina auth login --api-key YOUR_API_KEY -
Run Scans
alprina scan ./src --output results.json -
Process Results
# Fail on high severity alprina scan ./src --fail-on high
Integration Patterns
CI/CD Pattern
# Example: GitHub Actions
name: Security Scan
on: [push, pull_request]
jobs:
security:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Alprina
run: pip install alprina-cli
- name: Run Scan
run: alprina scan ./src --fail-on high
env:
ALPRINA_API_KEY: ${{ secrets.ALPRINA_API_KEY }}IDE Pattern
The Alprina CLI includes an acp (Alprina Code Protocol) mode for IDE integration:
# Start IDE integration server
alprina acp --port 8765Your IDE plugin connects to this server for real-time analysis.
Webhook Pattern
Configure webhooks to receive scan notifications:
// Express.js example
app.post('/webhooks/alprina', (req, res) => {
const { event, data } = req.body;
if (event === 'scan.completed') {
// Process completed scan
createJiraTicket(data);
sendSlackNotification(data);
}
res.status(200).send('OK');
});Authentication
All integrations require an API key. Get yours from the dashboard .
Environment Variables
export ALPRINA_API_KEY="your_api_key_here"Configuration File
# .alprina.yml
api_key: ${ALPRINA_API_KEY}
api_url: https://api.alprina.comCLI Login
alprina auth login --api-key YOUR_API_KEYBest Practices
- Use Secrets Management: Never commit API keys to version control
- Cache Dependencies: Speed up CI/CD by caching pip packages
- Fail on High Severity: Block deployments with critical vulnerabilities
- Generate Reports: Save scan results as build artifacts
- Monitor Usage: Track credit consumption in billing dashboard
Support
Need help with integration?
- Check individual integration guides
- Visit GitHub Discussions
- Email support@alprina.com
Last updated on