CLI Reference

# Download the CLI script
curl -o codestax https://codestax.co/cli/codestax
chmod +x codestax
 
# Or use directly with Python
python3 codestax.py <command>
 
# Verify installation
python3 codestax.py --version

export CODESTAX_API_KEY="your-api-key-here"
export CODESTAX_API_URL="https://codestax.co/api/v1"  # optional, defaults to production

codestax trigger --repo my-org/my-repo --type deep

codestax gate --repo my-org/my-repo --scan latest

codestax list --repo my-org/my-repo --limit 10

codestax issues --repo my-org/my-repo --severity critical,high

codestax dora --repo my-org/my-repo --period 30d

codestax export --repo my-org/my-repo --format sarif --output results.sarif

codestax review --repo my-org/my-repo --pr 42

name: CodeStax Security Gate
on: [pull_request]
 
jobs:
  security:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
 
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
 
      - name: Install CodeStax CLI
        run: |
          curl -o codestax.py https://codestax.co/cli/codestax
          chmod +x codestax.py
 
      - name: Trigger Scan
        env:
          CODESTAX_API_KEY: ${{ secrets.CODESTAX_API_KEY }}
        run: python3 codestax.py trigger --repo ${{ github.repository }} --wait
 
      - name: Enforce Quality Gate
        env:
          CODESTAX_API_KEY: ${{ secrets.CODESTAX_API_KEY }}
        run: python3 codestax.py gate --repo ${{ github.repository }} --max-critical 0 --max-high 3

codestax-gate:
  image: python:3.11-alpine
  stage: test
  before_script:
    - curl -o codestax.py https://codestax.co/cli/codestax
    - chmod +x codestax.py
  script:
    - python3 codestax.py trigger --repo $CI_PROJECT_PATH --wait
    - python3 codestax.py gate --repo $CI_PROJECT_PATH --max-critical 0
  variables:
    CODESTAX_API_KEY: $CODESTAX_API_KEY