audit-prep-assistant

Prepare codebases for security reviews with static analysis and documentation.

Updated Jul 10, 2025
One-click install
npx skills add https://github.com/Superlend/superloop-core-contracts --skill audit-prep-assistant
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: audit-prep-assistant
Source: https://github.com/Superlend/superloop-core-contracts/tree/main/.cursor/skills/building-secure-contracts/skills/audit-prep-assistant
Command: npx skills add https://github.com/Superlend/superloop-core-contracts --skill audit-prep-assistant

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Prepares codebases for security reviews using Trail of Bits' checklist, helping teams define goals, organize effort, and present clear evidence to auditors.

Core Features & Use Cases

  • Goal setting & scoping: Establish audit objectives, risk areas, and acceptance criteria.
  • Static analysis orchestration: Guide and consolidate analysis with tools like Slither (Solidity), dylint (Rust), and golangci-lint (Go).
  • Test coverage & dead-code cleanup: Increase coverage, triage findings, and remove unused code.
  • Documentation generation: Produce flowcharts, user stories, and inline comments to support the audit narrative.
  • Use Case: Before an audit, run the prep to collect artifacts and share a ready-to-review package with the assessment team.

Quick Start

Initialize the audit prep workflow by outlining goals, running the recommended static analysis tools, expanding test coverage, and generating documentation artifacts for the audit package.

Frequently Asked Questions about audit-prep-assistant

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I prepare a codebase for a security audit?

Codebase security audit preparation involves defining audit goals, running static analysis tools like Slither or golangci-lint, increasing test coverage, removing dead code, and generating documentation artifacts to present clear evidence to auditors.

What is included in an audit prep workflow for smart contracts?

An audit prep workflow for smart contracts includes establishing audit objectives, orchestrating static analysis with tools like Slither, expanding test coverage, triaging findings, and generating flowcharts and inline comments to support the audit narrative.

Does this audit prep process support Rust and Go codebases?

Yes, the audit prep process supports Rust and Go codebases by guiding and consolidating static analysis using dylint for Rust and golangci-lint for Go, alongside general test coverage and dead-code removal steps.

Why do I need to remove dead code before a security review?

Removing dead code before a security review reduces the attack surface and clarifies the codebase logic, allowing auditors to focus on active risk areas and verify test coverage without triaging unused or irrelevant code paths.

How do I use static analysis to organize a security audit?

Static analysis organizes a security audit by running linting tools to surface vulnerabilities and code inconsistencies, triaging the findings, and consolidating the results into a ready-to-review package for the assessment team.

What documentation artifacts do auditors need during a codebase review?

Auditors need documentation artifacts like flowcharts, user stories, and inline comments that explain the codebase's intended behavior, which are generated during audit prep to support a clear and structured audit narrative.