Documentation Index
Fetch the complete documentation index at: https://docs.solidscipt.zoracle.xyz/llms.txt
Use this file to discover all available pages before exploring further.
The audit-pack command assembles everything a security auditor needs into a self-contained bundle for each contract. Each bundle includes the TypeScript source, the generated Solidity, source maps, an audit report in Markdown, and Slither JSON output. By default the command also zips each bundle. Pass --no-zip when you want to inspect the contents directly or commit them to a repository without unpacking.
solidscript audit-pack <input>
Arguments
| Argument | Description |
|---|
<input> | Path to the directory containing your TypeScript contract files |
Options
| Flag | Description |
|---|
-o, --out <dir> | Root directory where audit bundles are written. Defaults to out/audit |
--no-zip | Write directory bundles only; skip .zip creation |
Output files
Each contract produces the following files inside out/audit/:
| File | Description |
|---|
<Contract>.ts | Original TypeScript source |
<Contract>.sol | Generated Solidity |
<Contract>.sourcemap.json | Source map linking Solidity back to TypeScript |
<Contract>.audit.md | Audit report in Markdown |
<Contract>.slither.json | Slither static analysis output |
<Contract>.zip | All of the above in a single archive (omitted with --no-zip) |
Examples
# Generate bundles with zip archives
npx solidscript audit-pack contracts
# Generate bundles without zip archives
npx solidscript audit-pack contracts --no-zip