CLI Reference

The SolStudio CLI is the local-project surface. Use it when the source of truth is on your machine: an Anchor, Pinocchio, Quasar, or unknown Solana project, a single Rust file, or an IDL JSON file.

It also includes solstudio cloud for the Cloud workflow platform. Use that namespace when the source of truth is hosted or self-hosted SolStudio Cloud: workflows, executions, credentials, node registry, and Cloud-only self-host setup.

Install

npm install -g @solstudio/cli

> **Requires** Node.js 18+ or Bun. After install the solstudio binary is available globally.

Want practice instead of reference reading? Open the CLI Learning Path and learn the commands with short exercises.

What The CLI Does

In this repo the examples use bun run solstudio. If the CLI is installed as a binary, use the same arguments after solstudio.

Recommended Local Flow

Use this sequence when you are opening an existing Solana codebase for the first time:

bun run solstudio init .
bun run solstudio parse . --format summary
bun run solstudio view .

For Cloud control:

solstudio cloud login --endpoint https://cloud.solstudio.fun --token sst_your_token
solstudio cloud whoami
solstudio cloud workflow list
solstudio cloud nodes list

Use this sequence when you only have an IDL file:

bun run solstudio idl ./target/idl/vault.json --format summary
bun run solstudio idl ./target/idl/vault.json --output vault-flow.json

Project Files

The CLI stores local metadata in .solstudio.

The config shape is:

{
  "name": "my-program",
  "framework": "anchor",
  "mode": "rust",
  "port": 6139
}

framework can be anchor, pinocchio, quasar, or unknown. mode is rust when the CLI can read source structure and editor when the project is unknown or scaffolded visually.

init

Initialize a directory for local SolStudio use.

bun run solstudio init [path]

Examples:

bun run solstudio init .
bun run solstudio init . --framework anchor
bun run solstudio init ./new-program --scaffold

Use init when:

• You want framework detection written before opening the visualizer.
• You want the CLI to remember the project mode.
• You want a tiny scaffold for an empty folder.

If the project is already initialized, init prints the existing framework, mode, and config path instead of overwriting the config.

view

Start the local server and open the visualizer.

bun run solstudio view [path]

Examples:

bun run solstudio view .
bun run solstudio view . --port 6140
bun run solstudio view . --no-open

view will create .solstudio/config.json if the project has not been initialized. When the server starts, it attempts an initial parse if no graph is saved yet, then serves the local UI.

Use view when:

• You want to inspect local Rust visually.
• You want the graph to update after parsing local files.
• You want a local-only workflow without uploading the project to the hosted app.

parse

Parse a project directory or one .rs file.

bun run solstudio parse [path]

Examples:

bun run solstudio parse .
bun run solstudio parse ./programs/vault/src/lib.rs
bun run solstudio parse . --format summary
bun run solstudio parse . --format json --output flow.json
bun run solstudio parse . --format ir --output flow-ir.json

Output formats:

summary prints instruction, account, state, error, event, logic, node, and edge counts. It also reports parser confidence, files parsed, files skipped, unsupported constructs, and warnings.

idl

Convert an IDL JSON file into flow data.

bun run solstudio idl <path>

Examples:

bun run solstudio idl ./target/idl/vault.json
bun run solstudio idl ./target/idl/vault.json --format summary
bun run solstudio idl ./target/idl/vault.json --output vault-flow.json

Use idl when:

• You have an Anchor, Codama, Kinobi, or compatible Solana IDL.
• You want instructions, accounts, errors, and events as graph nodes.
• You do not have the original Rust source.

Choosing The Right Command

cloud

Control hosted or self-hosted SolStudio Cloud from the terminal.

solstudio cloud login --endpoint https://cloud.solstudio.fun --token sst_your_token
solstudio cloud whoami
solstudio cloud status
solstudio cloud workflow list
solstudio cloud workflow create --name "SOL price alert" --definition workflow.json
solstudio cloud workflow run <workflow-id> --data payload.json
solstudio cloud execution list --workflow <workflow-id>
solstudio cloud credential create --label helius --type helius --set apiKey=...
solstudio cloud wallet list
solstudio cloud wallet create --label ops --network devnet
solstudio cloud nodes list
solstudio cloud profile set selfhost --endpoint https://203.0.113.10 --active

Profiles let one machine control hosted and self-hosted instances:

solstudio cloud login --profile hosted --endpoint https://cloud.solstudio.fun --token sst_hosted
solstudio cloud login --profile local --endpoint http://localhost:3001 --token sst_local
solstudio cloud profile use local

Self-host Cloud without the main IDE:

solstudio cloud self-host deploy ./solstudio-cloud --domain cloud.example.com
solstudio cloud self-host check ./solstudio-cloud
solstudio cloud self-host status ./solstudio-cloud
solstudio cloud self-host logs ./solstudio-cloud --tail 100

The default self-host image is ghcr.io/skartik-sk/solstudio-cloud:latest. Pass --image if you mirror the image to another registry.

Create API tokens from the Cloud app session with POST /api/cli/token, then store the returned token once with cloud login. New tokens are stored server-side as SHA-256 hashes.

Common Fixes

CLI Versus Other Surfaces