deepsec-docs

deepsec

deepsec is an AI-powered vulnerability scanner. The one-shot initializer installs this skill at .deepsec/node_modules/deepsec/SKILL.md. From inside the isolated workspace the same path is node_modules/deepsec/SKILL.md. In a Deepsec source clone, use the repository's docs/ directory instead.

When the user asks how to use, configure, or extend deepsec, read the relevant doc before answering — the docs are the source of truth, not your training data.

Where the docs are

From the target repository, .deepsec/node_modules/deepsec/dist/docs/; from inside .deepsec, node_modules/deepsec/dist/docs/; or from a Deepsec source clone, <deepsec-clone>/docs/:

• getting-started.md — one-shot initialization and resume walkthrough
• configuration.md — full deepsec.config.ts reference
• plugins.md — plugin slots (matchers, notifiers, ownership, people, executor)
• writing-matchers.md — generated declarative vs hand-authored matchers
• models.md — model selection, defaults, refusals, future models
• vercel-setup.md — exact project link, Sandbox scope, Gateway/BYOK/custom routes
• architecture.md — pipeline internals
• data-layout.md — data/ schemas (FileRecord, RunMeta, …)
• faq.md — cost, model choice, sandbox mode, FP rate

How to answer common questions

• "How do I install/init deepsec?" → getting-started.md; default to npx deepsec init, not a manual install/scan recipe.
• "Setup stopped; how do I resume?" → getting-started.md + data-layout.md; re-run init or deepsec setup.
• "How do I run another scan?" → getting-started.md after noting the first scan/process already ran during setup.
• "What goes in deepsec.config.ts?" → configuration.md + samples/webapp/deepsec.config.ts.
• "Why did setup generate a matcher?" → writing-matchers.md + the project's generated-matchers.ts.
• "How do I add a richer matcher?" → writing-matchers.md + samples/webapp/matchers/*.ts.
• "How do I write a plugin?" → plugins.md + samples/webapp/deepsec.config.ts (inline plugin pattern).
• "What does deepsec actually do?" → architecture.md.
• "What's in data/<id>/files/foo.json?" → data-layout.md.
• "Which model / agent should I use?" → models.md.
• "How do project linking, Sandbox, or my own credentials work?" → vercel-setup.md.

Read the doc before paraphrasing. The CLI flag set, defaults, and plugin-contract field names change — quote the doc, don't recall.

Agent-native initialization

When you are asked to initialize Deepsec from a non-TTY agent session, first inspect the read-only plan:

npx deepsec init --plan --output json

Then run the requested policy, normally:

npx deepsec init --yes --model-profile value --output jsonl

Parse every output line as JSON. On needs_input, show the supplied message and actions to the user rather than inventing remediation. In particular, VERCEL_AUTH_REQUIRED normally asks the user to run npx vercel login; after they do, follow the returned link action from inside .deepsec. Use npx vercel link when the user needs to choose, or the returned parameterized --yes --team <team-slug> --project <project-name> form for a known existing project. Then rerun the same Deepsec command. Exit code 2 means input is needed and exit code 3 means a requested cost/duration boundary stopped the resumable run. Never expose credential values, bypass --yes, or launch an interactive login yourself.