Command Line Reference
Basic example
export ESCAPE_APPLICATION_ID=<YOUR APPLICATION ID>
export ESCAPE_API_KEY=<YOUR API KEY>
npm i -g @escape.tech/action
escape-action
Available variables
ESCAPE_APPLICATION_ID string required
The id of the application on Escape that will be scanned continuously.
You can find it in your Escape application settings.
ESCAPE_API_KEY string required
Your API key on the Escape platform.
You can find it in your Escape settings.
TIMEOUT number
The timeout of the job. If set to 0, the scan will be started, but the job will not wait for it to be finished before terminating.
The triggered scan will run asynchronously on Escape, and your team will be notified once it is done using your desired notifications settings.
CONFIGURATION_OVERRIDE string
See the configuration override section.
CONFIGURATION_OVERRIDE_PATH string
See the configuration override section.
COMMIT_HASH string
See the commit identification section.