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.

This page lists every SolidScript CLI subcommand in one place so you can find what you need at a glance. Each row describes what the command does; follow the links in the cards below for full flag documentation and examples. You can also print this list at any time with npx solidscript --help.
npx solidscript --help
npx solidscript build contracts
npx solidscript deploy MyToken -n base-sepolia -a 1000000

Command reference

CommandDescription
doctorCheck the local environment and report any missing dependencies
init [dir]Scaffold a new SolidScript project with the recommended directory layout
build <input>Transpile TypeScript contracts to Solidity output files
validate <input>Run static checks against contract source
verify <input>Run the full verification pipeline against compiled artifacts
compile <input>Compile .sol files to ABI and bytecode artifacts
deploy <contract>Deploy a compiled artifact to a target network
secure-deploy <input>Run verification gates, then deploy only if all gates pass
verify-source <contract>Submit contract source to Etherscan v2 for public verification
audit <input>Run native rules plus Slither static analysis
audit-pack <input>Emit an auditor handoff bundle with source, ABI, and findings
gasdiff <input>Compare optimised and unoptimised bytecode size
testTranspile tests and run the Forge test suite
traceRewrite Solidity stack traces to TypeScript source locations
walletManage local hot wallets used for deployment
configManage user-level configuration values
optimize <input>Report gas optimisation suggestions for contract source
parse <input>Parse TypeScript contracts to IR JSON
help [command]Display help for a specific command

Common options

Most commands accept -h, --help to print their usage. Deployment and verification commands accept additional flags for network selection, constructor arguments, artifact paths, and pipeline gates — see the individual command pages for the full option reference.

Build

Transpile TypeScript contracts into Solidity output.

Verify

Run the security pipeline against contracts.

Deploy

Deploy with a browser wallet or a local test wallet.

Secure Deploy

Verify first, deploy only after passing gates.