Skip to content
SkillModel-led2,239 tokens in use

Audit Prep Assistant

Walks a team through Trail of Bits' checklist for getting a codebase ready for an external security review, one to two weeks before it starts.

8,319 stars on the repository CC-BY-SA-4.0trailofbits/skills · plugins/building-secure-contracts/skills/audit-prep-assistant
/plugin marketplace add trailofbits/skills
View source

Install command as written in the repository's README

Skill label

measured from its files

What installing Audit Prep Assistant costs

116tokens idle
2,239tokens in use

Idle is what sits in context while the skill is installed. In use is its instructions, loaded when it runs. Counts are approximate, made offline with cl100k_base.

Model dependence Model-led

Script-ledMixedModel-led

Mostly instructions, so how well it works depends on the model that follows them.

This describes the skill's structure, how much of it is scripts. It does not say how well it works.

Touches

shelldetectedgitdetected

Declared tags come from the skill's frontmatter; detected ones from its scripts, its code blocks and the commands it names in inline code. This is detected, not audited.

How it scores

Quality

How well the skill is written, counted from its own files: its frontmatter, its steps, examples, stated output and constraints, its size and whether every file it ships is one it names.How we score it →
Good
  • Frontmatter12/15
  • Structure23/25
  • Examples12/15
  • Output15/15
  • Size10/15
  • Resources0/15

Security

Starts at 100 and loses points for each thing in the skill's files that a reader should look at first.How we score it →
Excellent
  • Runs shell commands−5

    does this on the machine, and the frontmatter does not say so

    SKILL.md, line 42
  • Runs git commands−5

    does this on the machine, and the frontmatter does not say so

    SKILL.md, line 295

Repository health

Pre-computed score based on development activity, maintenance, community, maturity, and trend momentum.How we score it →
Good
  • Development activity100
  • Maintenance52
  • Community64
  • Maturity32
  • Momentum40

Audit Prep Assistant helps the owner of a codebase get it ready for outside assessors. It sets review goals, runs static analysis, raises test coverage, removes dead code, makes the code easy to build and read, and generates documentation.

The deliverable is a prep package: a goals document, a triaged static analysis report, a coverage report, a file scope list, build instructions, a frozen commit and a documentation set, tracked in a checklist.

What You Get

  • A review goals document with objectives, areas of concern, worst-case scenario and questions for auditors
  • A triaged static analysis report and a test coverage report with the untested paths named
  • A scope list, verified build instructions and a frozen commit or branch
  • Flowcharts, user stories, an actors and privileges map, function documentation and a glossary
  • A prep checklist of completed and remaining items

Common Use Cases

  • Preparing a Solidity protocol for an external audit
  • Working out what to fix before auditors start
  • Asking what assessors need from a project
  • Cleaning up dead code and boilerplate before a review

What Makes It Unique

It encodes the preparation checklist of a security firm and applies it as a sequence that cannot be skipped. A table of rationalizations, such as a README being enough for setup or coverage that looks decent, maps each excuse to the action required. It is for the team being audited, and it points to audit-context-building for someone studying unfamiliar code.

Under The Hood

The skill is a single instruction file with no scripts and no declared tool list. It tells the agent to run static analysis commands such as slither, dylint and golangci-lint, and a coverage tool such as forge coverage, then edit the project to fix easy issues and write documentation files like architecture, user stories and glossary documents. It does not fetch web pages or call remote services.

Join founders building with open source

Opinionated takes, migration guides, cost-saving tips, and insights from the open source ecosystem.

Subscribe on SubstackJoin 750+ subscribers