Skip to main content

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 command runs SolidScript’s native static analysis rules and then Slither against the generated Solidity. It uses source maps to remap every diagnostic back to the original TypeScript file and line number, so you can act on findings without switching between Solidity and TypeScript views. Use --strict in CI to block merges on any finding, even low-severity ones. 
solidscript audit <input>

​
Arguments

ArgumentDescription
<input>Path to the directory containing your TypeScript contract files

​
Options

FlagDescription
--strictExit with a nonzero status code on any finding, including informational ones
-o, --out <dir>Directory containing the compiled .sol artifacts. Defaults to out/sol

​
Examples

# Run audit with default settings
npx solidscript audit contracts

# Run in strict mode — fail on any finding
npx solidscript audit contracts --strict
Diagnostics are reported at TypeScript source locations when a source map is available. If source maps are missing, run solidscript build first to regenerate them.