Skip to content

cli.md

Latest commit

 

History

History
373 lines (265 loc) · 6.99 KB

cli.md

File metadata and controls

373 lines (265 loc) · 6.99 KB

CLI Reference

The SolScript command-line interface for compiling and managing projects.

Installation

cargo install solscript

Commands

solscript build

Compile a SolScript file to Anchor/Rust.

solscript build <FILE> [OPTIONS]

Arguments:

  • <FILE> - Path to the .sol source file

Options:

  • -o, --output <DIR> - Output directory (default: ./output)
  • --no-color - Disable colored output

Example:

solscript build counter.sol -o ./build

Output Structure:

./build/
├── Anchor.toml
├── Cargo.toml
├── programs/
│   └── counter/
│       ├── Cargo.toml
│       └── src/
│           └── lib.rs
└── tests/
    └── counter.ts

solscript check

Type-check a SolScript file without generating output.

solscript check <FILE>

Arguments:

  • <FILE> - Path to the .sol source file

Example:

solscript check token.sol

Output:

  • Success: No output, exit code 0
  • Errors: Displays type errors with source locations

solscript parse

Parse a file and display the AST.

solscript parse <FILE> [OPTIONS]

Arguments:

  • <FILE> - Path to the .sol source file

Options:

  • --json - Output AST as JSON (default: debug format)

Example:

solscript parse counter.sol --json > ast.json

solscript build-bpf

Compile to Solana BPF bytecode.

solscript build-bpf <FILE> [OPTIONS]

Arguments:

  • <FILE> - Path to the .sol source file

Options:

  • -o, --output <DIR> - Output directory (default: ./target)
  • --opt-level <LEVEL> - Optimization level: 0, 1, 2, 3 (default: 2)
  • --keep-intermediate - Keep intermediate Anchor files
  • --llvm - Use direct LLVM compilation (requires LLVM 18)

Compilation Modes:

  1. Anchor Mode (Default): Generates Rust/Anchor code, then compiles with cargo build-sbf

    solscript build-bpf token.sol -o ./deploy

  2. Direct LLVM Mode: Compiles directly to BPF via LLVM (faster, requires LLVM 18)

    solscript build-bpf --llvm token.sol -o ./deploy

Examples:

# Standard compilation via Anchor
solscript build-bpf token.sol -o ./deploy --opt-level 3

# Direct LLVM compilation (faster)
solscript build-bpf --llvm counter.sol -o ./deploy

# Keep intermediate files for debugging
solscript build-bpf token.sol --keep-intermediate

Requirements:

  • Anchor Mode: Solana CLI tools, cargo-build-sbf
  • LLVM Mode: LLVM 18 with BPF target, LLVM_SYS_180_PREFIX set

solscript deploy

Deploy a compiled program to Solana.

solscript deploy <FILE> [OPTIONS]

Arguments:

  • <FILE> - Path to the .sol source file

Options:

  • -o, --output <DIR> - Build output directory (default: ./target)
  • --network <NETWORK> - Target network: devnet, testnet, mainnet (default: devnet)
  • --keypair <PATH> - Path to keypair file
  • --skip-build - Skip the build step

Example:

solscript deploy token.sol --network devnet --keypair ~/.config/solana/id.json

solscript test

Run tests for a SolScript project.

solscript test <FILE> [OPTIONS]

Arguments:

  • <FILE> - Path to the .sol source file

Options:

  • -o, --output <DIR> - Build output directory (default: ./target)
  • --skip-build - Skip the build step

Example:

solscript test counter.sol

solscript new

Create a new SolScript project from a template.

solscript new <NAME> [OPTIONS]

Arguments:

  • <NAME> - Project name (optional if using --list)

Options:

  • -t, --template <TEMPLATE> - Template to use (default: counter)
  • --list - List available templates

Available Templates:

Template Difficulty Description
simple Beginner Minimal contract for learning
counter Beginner Counter with ownership (default)
token Intermediate ERC20-style fungible token
voting Intermediate Decentralized voting system
escrow Advanced Trustless escrow with disputes
nft Advanced ERC721-style NFT collection

Examples:

# List all templates
solscript new --list

# Create with default template (counter)
solscript new my-project

# Create with specific template
solscript new my-token --template token
solscript new my-nft -t nft

Generated Structure:

my-project/
├── src/
│   └── main.sol        # Contract code
├── solscript.toml      # Project configuration
├── .gitignore
└── README.md

solscript init (Deprecated)

!!! warning "Deprecated" solscript init is deprecated. Use solscript new instead.

Initialize a new SolScript project (legacy command).

solscript init <NAME>

This command is an alias for solscript new <NAME> --template counter.

solscript add

Add a dependency to the project.

solscript add <PACKAGE> [OPTIONS]

Arguments:

  • <PACKAGE> - Package name or GitHub URL

Options:

  • --version <VERSION> - Package version
  • --git <URL> - Git repository URL
  • --branch <BRANCH> - Git branch name

Examples:

# Add from registry
solscript add @solana/spl-token

# Add from GitHub
solscript add --git https://github.com/user/lib --branch main

solscript doctor

Check the development environment.

solscript doctor

Output:

SolScript Environment Check
============================
Solana CLI:     ✓ installed (1.18.0)
Anchor CLI:     ✓ installed (0.30.0)
cargo-build-sbf: ✓ installed
Node.js:        ✓ installed (20.0.0)

All tools available!

solscript lsp

Start the Language Server Protocol server.

solscript lsp [OPTIONS]

Options:

  • --stdio - Use stdio for communication (default)
  • --tcp <PORT> - Use TCP on specified port

Example:

solscript lsp --stdio

Used by IDE extensions for code intelligence.

Configuration

solscript.toml

Project configuration file:

[package]
name = "my-project"
version = "0.1.0"
description = "My SolScript project"

[solana]
cluster = "devnet"
program_id = "11111111111111111111111111111111"

[build]
output_dir = "./target"
optimization = 2

[dependencies]
spl-token = { git = "https://github.com/solana-labs/solana-program-library", branch = "master" }

Environment Variables

Variable Description Default
SOLSCRIPT_OUTPUT Default output directory ./output
SOLANA_KEYPAIR Path to keypair file ~/.config/solana/id.json
SOLANA_CLUSTER Target cluster devnet

Exit Codes

Code Meaning
0 Success
1 Compilation error
2 Type checking error
3 Runtime/deployment error
4 Configuration error

See Also