Back to Novu

deepsec

.deepsec/README.md

3.18.02.5 KB
Original Source

deepsec

This directory holds the deepsec config for the parent repo. Checked into git so teammates inherit project context (auth shape, threat model, custom matchers); generated scan output is gitignored.

Currently configured project: novu (target: ..).

Setup

  1. pnpm install — installs deepsec.
  2. Add an AI Gateway / Anthropic / OpenAI token to .env.local. If you already have claude or codex CLI logged in on this machine, you can skip the token for non-sandbox runs (process / revalidate / triage); deepsec auto-detects and reuses the subscription. See node_modules/deepsec/dist/docs/vercel-setup.md after install.
  3. Open the parent repo in your coding agent (Claude Code, Cursor, …) and have it follow data/novu/SETUP.md to fill in data/novu/INFO.md.

Daily commands

bash
pnpm deepsec scan
pnpm deepsec process     --concurrency 5
pnpm deepsec revalidate  --concurrency 5                  # cuts FP rate
pnpm deepsec export      --format md-dir --out ./findings

--project-id is auto-resolved while there's only one project in deepsec.config.ts. Once you've added a second project, pass --project-id novu (or whichever id you want) explicitly.

scan is free (regex only). process is the AI stage (≈$0.30/file on Opus by default). Run state goes to data/novu/.

Adding another project

To scan another codebase from this same .deepsec/:

bash
pnpm deepsec init-project ../some-other-package   # path relative to .deepsec/

Appends an entry to deepsec.config.ts and writes data/<id>/{INFO.md,SETUP.md,project.json}. Open the new SETUP.md in your agent to fill in INFO.md.

Layout

deepsec.config.ts        Project list (one entry per scanned repo)
data/novu/
  INFO.md                Repo context — checked into git, hand-curated
  SETUP.md               Agent setup prompt — checked in, deletable
  project.json           Generated (gitignored)
  files/                 One JSON per scanned source file (gitignored)
  runs/                  Run metadata (gitignored)
  reports/               Generated markdown reports (gitignored)
AGENTS.md                Pointer for coding agents
.env.local               Tokens (gitignored)

Docs

After pnpm install:

  • Skill: node_modules/deepsec/SKILL.md
  • Full docs: node_modules/deepsec/dist/docs/{getting-started,configuration,models,writing-matchers,plugins,architecture,data-layout,vercel-setup,faq}.md

Or browse on GitHub.