For the complete documentation index, see llms.txt. This page is also available as Markdown.

What you will find in these docs

The section map, role-based starting points, and key terms.

These docs are organized into ten sections, ordered roughly from "what is this?" to "look up the exact flag I need."

The section map

  • Introduction (you are here): what Seal is, how it works, who it is for, and the vocabulary used throughout the docs.

  • Getting started: sign-in, user management, tokens, your first Seal Project, and an end-to-end Proof of Value walkthrough.

  • Discovering vulnerabilities: how Seal finds your packages and how to navigate the platform to triage findings, including the Protection page, package states, and the Repository page.

  • Using the Seal Platform: the day-to-day operating manual. Sealing Rules, working with each of the five products, the Seal AI Agent, the Seal Engineer, the Notification Center, the Reports Manager, and the Usage page.

  • Application and OS setup: day-1 setup guides for Seal Apps and Seal OS, including the Seal CLI in CI/CD, the Seal Artifact Server, and standalone on-prem environments.

  • Container and image setup: day-1 setup guides for Seal Base Images, Seal My Container, and Seal Vendor Apps.

  • Integrations: connecting Seal to internal SCA scanners, external scanner feeds, JFrog Artifactory, GitHub, and the package renaming feature.

  • Trust & compliance: code diff transparency, attestations, cryptographic signing, the 72-hour SLA, and supported compliance frameworks.

  • Reference: CLI commands and flags, Public API, naming and versioning conventions, and network requirements.

  • FAQ & disclosure: frequently asked questions and the vulnerability disclosure policy.

Find your starting point by role

Role
Focus
Start here

Security leader

Evaluating Seal; reviewing the Dashboard and reports

DevOps engineer

Setting up integrations; operating the platform side day to day

Developer

Integrating the Seal CLI; applying Sealing Rules

Security analyst

Day-to-day triage, notifications, and reports for leadership

The DevOps guide also covers DevSecOps and platform engineers; everyone responsible for the platform side of operating Seal in your organization.

Key terms

Seal uses a precise vocabulary across these docs. The most common terms you will encounter:

  • A sealed package is a drop-in replacement for a public package version, with security fixes backported in.

  • A Sealing Rule tells Seal which package to replace and with which sealed version.

  • A Seal Project is the entity inside the Seal Platform that represents one of your codebases or build pipelines.

  • The package discovery mode of a Seal Project determines how Seal sees your packages: source code, CLI, artifact server, or imported manifest.

  • A deployment method is how Seal is integrated into your environment, for example the Seal CLI in CI/CD, or the Seal Artifact Server as a configured remote.

  • The CLI fix mode is the mode the Seal CLI runs in: local mode (rules from a .seal-actions.yml file in your source), remote mode (rules from the Seal Platform UI), or all mode (every vulnerable package replaced automatically).

The full vocabulary is in the Glossary.

Last updated