Documentation

Guides & API Reference

Everything you need to integrate ProdSensor into your workflow

Getting Started

New to ProdSensor? Start here to learn the basics and run your first analysis.

CI/CD Integration

Automate production readiness checks in your pipeline.

API Reference

Build custom integrations with our REST API.

  • Authentication API Keys
  • POST /v1/analyze/repo
  • GET /v1/runs/{id}/report.json

Security & Trust

Learn how we protect your code and data.

Quick Reference

Common tasks and code examples

GitHub Action

- uses: prodsensor/action@v1
  with:
    api-key: ${{ secrets.PRODSENSOR_API_KEY }}
    fail-on: 'blockers'
    comment-on-pr: 'true'

CLI Tool

# Install
pip install prodsensor-cli

# Set API key
export PRODSENSOR_API_KEY=ps_live_xxx

# Analyze
prodsensor analyze https://github.com/owner/repo

Need Help?

Contact us at hello@prodsensor.com or open an issue on GitHub

Contact Support Open Issue