Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/blueshift-gg/quasar/llms.txt

Use this file to discover all available pages before exploring further.

The quasar CLI is the primary tool for working with Quasar Solana programs. It wraps every stage of your development workflow — from scaffolding a new project to deploying a compiled binary on-chain — into a single, consistent interface. Every command is designed around the zero-copy, zero-allocation design philosophy of the framework: fast to run, minimal in output, and predictable in behavior.

​
Installation

Clone the repository and install from the cli crate with Cargo: 
git clone https://github.com/blueshift-gg/quasar
cd quasar
cargo install --path cli
After installation, verify it is available: 
quasar --version

​
Available Commands

All commands follow the pattern quasar <command> [options]. Run quasar <command> --help to see the full flag list for any individual command.
CommandDescription
initScaffold a new Quasar project
addAdd instructions, state accounts, or error enums
buildCompile the on-chain program to a .so binary
testRun the test suite (Rust or TypeScript)
deployDeploy the program to a Solana cluster
cleanRemove build artifacts
configRead and write global CLI settings
idlGenerate the program IDL from a crate
clientGenerate TypeScript, Python, or Go client code from IDL
lintAudit the program surface for upgrade-safety issues
profileMeasure per-function compute-unit usage
dumpDisassemble sBPF bytecode
keysManage the program keypair
completionsGenerate shell completion scripts

​
Global Options

FlagDescription
-h, --helpPrint help for the CLI or any subcommand
-V, --versionPrint the installed version
To get detailed help on any command, pass --help after the command name: 
quasar build --help
quasar deploy --help
quasar profile --help

​
Shell Completions

The completions subcommand generates shell completion scripts for bash, zsh, fish, and PowerShell. Pipe the output to the appropriate location for your shell: 
# Bash
quasar completions bash > ~/.bash_completion.d/quasar

# Zsh
quasar completions zsh > ~/.zfunc/_quasar

# Fish
quasar completions fish > ~/.config/fish/completions/quasar.fish

# PowerShell
quasar completions powershell > quasar.ps1
After adding the completion file, restart your shell or source the appropriate configuration file to activate completions.

​
Inspecting Global Settings

The CLI maintains a global configuration file at ~/.quasar/config.toml that stores your default toolchain, test framework, template preferences, and UI settings. Print all current values with: 
quasar config list
To read a single key: 
quasar config get defaults.toolchain
To change a value: 
quasar config set defaults.toolchain solana
Settings saved by quasar config become the defaults for quasar init prompts. You can override any value at the command line with the corresponding flag.

​
CLI Sub-pages

init & add

Scaffold a new project, add instructions, state, and errors, manage keypairs and config.

Build, Test, Deploy

Compile your program, run tests, and deploy to devnet or mainnet.

Profile & Dump

Measure compute-unit usage and disassemble sBPF instructions.

IDL & Client

Extract the program IDL and generate TypeScript, Python, or Go client code.

Build docs developers (and LLMs) love

Get started for freeTalk to us