CircleCI Integration¶

Quick Start¶

Add the following configuration to your .circleci/config.yml:

version: 2.1

jobs:
  deploy: 
    docker:
      - image: node:alpine
    steps:
      - checkout
      # Your deployment steps here

  escape_scan:
    docker:
      - image: node:alpine
    steps:
      - checkout
      - run:
          name: Install Escape CLI
          command: |
            npm install -g @escape.tech/action
            npm show @escape.tech/action version
      - run:
          name: Run Escape Scan
          command: escape-action
      environment:
        ESCAPE_APPLICATION_ID: $ESCAPE_APPLICATION_ID
        ESCAPE_API_KEY: $ESCAPE_API_KEY

workflows:
  version: 2
  deploy_and_scan:
    jobs:
      - deploy
      - escape_scan:
          requires:
            - deploy
          filters:
            branches:
              only: staging

Configuration Options¶

Environment Variables¶

ESCAPE_APPLICATION_ID: Your Escape application identifier
ESCAPE_API_KEY: Your Escape API key

Workflow Settings¶

requires: Define job dependencies
filters: Control branch execution
environment: Set scan environment variables

Failure behavior¶

The Escape CLI will:

Exit with code 1 if high-severity issues are found
Can be configured to fail on different severity levels

Available variables and options¶

See CLI documentation for complete configuration options.