Quickstart

The installer prints a link and opens it in your browser. Sign in with GitHub if you have not yet (your personal workspace is created for you), check that the page shows the same code as your terminal, and approve. The installer then downloads the build for your machine, verifies its checksum, and stores the sign-in on this machine.

curl -fsSL https://atmoslab.dev/install.sh | bash

irm https://atmoslab.dev/install.ps1 | iex

curl -fsSL https://atmoslab.dev/install.cmd -o install.cmd && install.cmd && del install.cmd

To confirm the install worked, run:

atmos --version

From here on, atmos self-update keeps the binary current, and atmos logout signs the machine out. Every machine you sign in on is listed on the dashboard's Tokens page, where you can revoke it.

cd your-project
atmos scan .

atmos scan checks your code and your dependencies in one run and closes with one summary. Findings appear in your terminal and, seconds later, on your dashboard. The project onboards itself on the first scan. To run one check alone, use atmos sast . or atmos sca .

CI and other headless environments use a Workspace Token instead of a sign-in. Create one on the dashboard's Tokens page (owners and admins), store it as a secret, and use it both to download the scanner and to scan:

curl -fL -H "Authorization: Bearer $ATMOS_TOKEN" \
  "https://ingest.atmoslab.dev/v1/cli/download?artifact=linux-x86_64" \
  -o atmos && chmod +x atmos

- run: atmos scan .
  env:
    ATMOS_TOKEN: ${{ secrets.ATMOS_TOKEN }}

Use curl 7.58 or newer. The exit code decides the build. With the GitHub App connected, findings also show on the pull request. See pull request feedback.