Skip to content
GitHubBook a demo

Use

Quickstart

0security is software infrastructure to deploy sovereign, persistent AI security agents that find and fix security risks across any tech stack, work with any model, and run anywhere.

Terminal window
curl -fsSL https://raw.githubusercontent.com/0sec-labs/0security/main/install.sh | bash

Supports Apple Silicon macOS and x64 or ARM64 Linux. Installs a checksum-verified binary to ~/.0/bin and adds it to your PATH. Set INSTALL_DIR to change the folder.

Windows is experimental: download 0-windows-x64.exe from Releases.

0 checks GitHub for a newer release when it starts in a terminal, at most once a day, and installs it by default. A console left running (0) checks every six hours and offers Update and restart on its update card. Change this under Settings → Updates (off, notify, automatic). To update now, run 0 config doctor upgrade. It replaces the binary it was started from and verifies the checksum first. See Update checks.

If an old copy never updates, run the installer again. Copies older than 0.33 cannot update from the console, so do this once; after that the card works. It always installs the latest release and keeps your settings:

Terminal window
curl -fsSL https://raw.githubusercontent.com/0sec-labs/0security/main/install.sh | bash

https://docs.0.security/install.sh redirects to the same script.

  1. Open the app. Run 0. The browser app opens at http://127.0.0.1:48123. No account is needed.

  2. Connect a model. Open Settings → Models and add a provider key or sign in. See Models.

  3. Start a thread. Press New thread, pick a folder and describe the job, for example “Review this folder for injection bugs and verify what you find”. See Threads.

  4. Review findings. Open Findings. Each finding links to its evidence. See Findings for how a finding is marked verified.

The Finish setting up card in the sidebar tracks steps 2 and 3.

Term Meaning
Thread A conversation with the agent. You describe a job; it plans, runs tools and records findings. See Threads.
Sentinel A named, standing job. It wakes on a schedule, on a pull request or by hand. See Sentinels.
Computer The machine where threads run and tools execute: this one, a VM or a remote server. See Computers.
Folder The directory a thread works in.
Skill A folder of instructions the agent loads when a task needs it. Not code. See Skills.
Extension An installable git folder, pinned to a commit, that can bundle skills, scripts, MCP servers and a connection. See Extensions.
Finding A security issue with evidence. One without reproduced evidence is a lead. See Findings.

Everything the console does is also a command. You need a connected model (0 models connect).

Terminal window
export OPENAI_API_KEY=...
0 threads send new "Review ./your-repo for injection bugs"
0 findings list

0 findings list --format sarif or --format json exports findings. See the CLI reference for every command.

Start with 0 config doctor. It checks the runtime, your model provider and the CLIs on your PATH.

  • 0: command not found. The binary is at ~/.0/bin/0. Open a new terminal or run export PATH="$HOME/.0/bin:$PATH". A source build has no global 0; run node packages/cli/dist/index.js.
  • Download or checksum errors. install.sh checks the binary against the release checksums.txt and refuses a mismatch. Release assets are 0-darwin-arm64, 0-linux-x64, 0-linux-arm64 and, manually, 0-windows-x64.exe. Intel Macs have no native release; use Docker or a source build. 0 config doctor upgrade does not support Windows.
  • API provider missing or bad. No usable model credential was found. Connect one in Settings → Models or export a key. configured means a credential was found, not that it works; the first model request tests access and quota. See Models.
  • A 0 ... variable will not export. Some shells reject names that start with a digit. Use env ZERO_...=... 0 ....
  • database is locked. Two processes write the same SQLite file. Stop the other one. Do not delete a live database. 0 config doctor --fix moves a damaged file aside and creates a fresh one; it does not recover rows, so back up first.
  • The app does not open. Use 0 --no-open and open the printed URL. On macOS, the first access to Desktop, Documents or Downloads makes macOS ask for permission; if you declined, enable the app that runs 0 under System Settings → Privacy & Security → Files & Folders.
  • Docker prints help and exits. The image runs 0 --help by default and mounts nothing. Pass your folder, key and a command (see Server mode and Docker).

Still stuck? Run 0 config doctor and open an issue with its output, the command and the error, without keys, tokens or target data. For a vulnerability in 0 itself, follow SECURITY.md.