Skip to main content

Home/examples

Example outputs

Pre-generated artifacts from scanning the repo's E2E fixture skills. Open any file below; each entry lists the CLI flags and example commands used to produce it.

Sample reports

HTML for browsers, plain text for logs and diffs, JSON for tooling and re-rendering other formats.

examples/
  • ├── audit-report.html

    Self-contained HTML report for browsers.

    agentsec audit --path ./e2e/fixtures --format html --output examples/audit-report.html

agentsec report examples/audit-report.json --format html --output examples/audit-report.html
  • ├── audit-report.txt

    Plain-text report (no ANSI), suitable for logs and diffs.

    agentsec audit --path ./e2e/fixtures --format text --output examples/audit-report.txt

agentsec report examples/audit-report.json --format text --output examples/audit-report.txt
  • └── audit-report.json

    Full machine-readable audit payload (skills, findings, scores).

    agentsec audit --path ./e2e/fixtures --format json --output examples/audit-report.json

Common flags

--path
Directory or single skill to scan (repo example uses ./e2e/fixtures).
-f / --format
text, json, html, sarif.
-o / --output
Write the report to a file instead of only stdout.
report
agentsec report <audit.json> re-renders from a saved JSON audit using --format and --output.

From this repository root you can run the same commands with bun packages/cli/src/cli.ts instead of agentsec.

All example files

README, config template, SARIF export, and CI workflow — same tree as the repository examples/ folder.

examples/
  • ├── README.md

    Overview of these files and how to regenerate reports.

  • ├── agentsec.config.example.ts

    TypeScript policy and scanner configuration template.

    # Copy or adapt as agentsec.config.ts / your bundler entry; see file header comments.

    Not produced by audit — reference configuration only.

  • ├── audit-report.sarif

    SARIF 2.1 for VS Code, GitHub, and other SARIF consumers.

    agentsec audit --path ./e2e/fixtures --format sarif --output examples/audit-report.sarif

agentsec report examples/audit-report.json --format sarif --output examples/audit-report.sarif
  • └── .github/
    • └── workflows/
      • └── agentsec.yml

        Example GitHub Actions workflow running AgentSec on push/PR.

        # Uses agentsec in CI; open the file for the exact job steps and flags.