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 init command scaffolds everything you need to start writing TypeScript smart contracts. It creates a ready-to-run project with a sample Counter contract, a SolidScript config file, TypeScript settings, and package scripts wired up for the full build-to-deploy workflow. Run it once in a new or empty directory to get started immediately. 
solidscript init [dir]

​
Arguments

ArgumentDescription
[dir]Directory to scaffold into. Use . for the current directory, or provide a name to create a new subdirectory. Defaults to the current directory.

​
What gets created

FilePurpose
contracts/Counter.tsStarter contract in TypeScript
solidscript.config.tsProject-level SolidScript configuration
tsconfig.jsonTypeScript compiler settings
.gitignoreSensible defaults for generated artifacts
Package scriptsbuild, validate, verify, compile, and deploy wired up and ready to run

​
Examples

# Scaffold into the current directory
npx solidscript init .

# Scaffold into a new subdirectory called my-app
npx solidscript init my-app