Reference

Editor extension

The Atmos extension for VS Code and Cursor runs the same scan and the same rules inside your editor. Findings appear as squiggles and in the Problems panel. A findings view groups them by rule or package and shows the full trace for each one, and dependency findings mark the affected entry in the lockfile itself.

Install#

The extension runs the atmos binary from your PATH, or from atmos.binaryPath, and needs atmos 0.5.0 or later. With an older atmos, a notice says which version is needed, and atmos self-update updates the CLI. If the CLI is not installed yet, start with the Quickstart.

  1. Download the .vsix from the Install page on the platform and install it with the Extensions: Install from VSIX command.
  2. The install script signs this machine in. If it is not signed in yet, click Sign in in the Atmos view or run Atmos: Sign In. The sign-in page opens in your browser with the code to confirm, and a notification says who you are signed in as.
  3. Save a file, or run Atmos: Scan Workspace Now. Findings appear inline and in the Atmos view in the Activity Bar.

How it behaves#

BehaviorDetail
Scan triggerOn save (default) or manual. To scan as you type, turn on Auto Save in the File menu, and every save scans. Rescans after an edit recheck only what changed. See warm scans.
UploadsAutomatic scans upload nothing. Atmos: Scan and Upload sends the findings of that scan to your workspace, and the atmos.upload.onAutoScan setting uploads every automatic scan too. In a VS Code workspace in Restricted Mode, the extension uploads nothing until you trust that workspace. Every scan needs network access.
Ignored findingsFindings your repository's .atmos-ignore.yaml covers stay out of the editor and the Findings view. The output log says how many each scan left out.
CredentialsThe extension holds no credential of its own. Every scan runs the CLI, which uses the sign-in stored by atmos login, so signing in or out in a terminal does the same for the editor, and the Atmos view shows it after the next scan.
Signed outAtmos: Sign Out signs this machine out and clears Atmos's entries from the Problems panel. While signed out, the Findings view is hidden and the Scan and Settings view shows a Sign in row.