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.

Installing SolidScript adds the TypeScript parser, solc JavaScript bindings, OpenZeppelin contracts, and viem to your project. A second command — npx solidscript doctor --fix — downloads the heavier native tools used by the security and deploy pipeline so you do not need to install Python, Rust, Foundry, or native solc separately. SolidScript requires Node 18 or newer.

Install the package

npm install solidscript

Prepare native tools

Then run:
npx solidscript doctor --fix
doctor --fix downloads Foundry tools (forge, anvil) into ~/.solidscript/bin/ and pulls Docker images for Slither and Mythril when Docker is available.
ToolHow SolidScript gets it
solcBundled as JavaScript through the npm package
OpenZeppelinBundled as a package dependency
forge and anvilAuto-downloaded from Foundry releases
SlitherDocker image when Docker is present, native PATH fallback
MythrilDocker image when Docker is present, native PATH fallback
Run npx solidscript doctor any time you want to see which tools are cached, installed globally, or missing.