CLI

Use the Squads CLI to create multisigs, manage configuration, vote on proposals, and execute transactions from the command line.

Installation

Install with Cargo (requires Rust):

cargo install squads-multisig-cli

Verify the installation:

squads-multisig-cli --help

Wallet support

The Squads CLI supports the same wallet types as the Solana CLI.

File system wallet
Ledger

Specify the keypair path:

squads-multisig-cli example-command --keypair /path/to/keypair.json

Specify the Ledger device URL:

# Default derivation path
squads-multisig-cli example-command --keypair usb://ledger

# Custom derivation path
squads-multisig-cli example-command --keypair usb://ledger/BsNsvfXqQTtJnagwFWdBS7FBXgnsK8VZ5CmuznN85swK?key=0/0

Read more about Ledger derivation paths here.

Global parameters

These are available on every command. Optional unless noted.

Parameter	Description
`--rpc-url`	Solana RPC endpoint. Defaults to mainnet
`--program-id`	Multisig program ID. Defaults to the standard Squads V4 program
`--keypair`	Path to your keypair file (required)

Commands

multisig-create

Create a new multisig with initial members and a threshold.

multisig-create --keypair <KEYPAIR_PATH> --members <MEMBER_LIST> --threshold <THRESHOLD> [--config-authority <CONFIG_AUTHORITY>] [--rent-collector <RENT_COLLECTOR>]

Parameter	Required	Description
`--members`	Yes	List of members’ public keys with permissions
`--threshold`	Yes	Number of approvals required to execute
`--config-authority`	No	Address given unilateral control over the multisig configuration (members, threshold). Setting it makes the multisig controlled instead of autonomous
`--rent-collector`	No	Address that receives the rent reclaimed from closed transaction accounts (executed, rejected, cancelled, or stale). If omitted, rent reclamation is turned off

Permission values:

Permission	Value
Proposer	1
Voter	2
Executor	4
All (Proposer + Voter + Executor)	7

Examples:

# Create multisig with two members
multisig-create --keypair /path/to/keypair.json \
  --members "Member1PubKey,Permission1 Member2PubKey,Permission2" \
  --threshold 2

# Create multisig with Config Authority
multisig-create --keypair /path/to/keypair.json \
  --config-authority <CONFIG_AUTHORITY_PUBKEY> \
  --members "Member1PubKey,Permission1 Member2PubKey,Permission2" \
  --threshold 1

config-transaction-create

Create a config change transaction for your multisig.

config-transaction-create --keypair <KEYPAIR_PATH> --multisig-pubkey <MULTISIG_PUBLIC_KEY> --action <ACTION> [--memo <MEMO>]

Parameter	Required	Description
`--multisig-pubkey`	Yes	Public key of the multisig account
`--action`	Yes	Configuration action to execute
`--memo`	No	Memo for the transaction

Supported actions:

AddMember

config-transaction-create --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --action "AddMember <NEW_MEMBER_PUBLIC_KEY> <PERMISSIONS>"

RemoveMember

config-transaction-create --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --action "RemoveMember <MEMBER_PUBLIC_KEY>"

ChangeThreshold

config-transaction-create --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --action "ChangeThreshold <NEW_THRESHOLD>"

SetTimeLock

config-transaction-create --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --action "SetTimeLock <TIME_LOCK_VALUE>"

AddSpendingLimit

config-transaction-create --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --action "AddSpendingLimit <CREATE_KEY> <VAULT_INDEX> <MINT> <AMOUNT> <PERIOD> <MEMBERS> <DESTINATIONS>"

<PERIOD> must be one of OneTime, Day, Week, or Month (case-sensitive). <MEMBERS> and <DESTINATIONS> are comma-separated lists of public keys.

RemoveSpendingLimit

config-transaction-create --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --action "RemoveSpendingLimit <SPENDING_LIMIT_PUBKEY>"

SetRentCollector

config-transaction-create --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --action "SetRentCollector <NEW_RENT_COLLECTOR_PUBKEY>"

config-transaction-execute

Execute an approved config change transaction.

config-transaction-execute --keypair <KEYPAIR_PATH> --multisig-pubkey <MULTISIG_PUBLIC_KEY> --transaction-index <TRANSACTION_INDEX>

Parameter	Required	Description
`--multisig-pubkey`	Yes	Public key of the multisig account
`--transaction-index`	Yes	Index of the transaction to execute

config-transaction-execute --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --transaction-index 1

proposal-vote

Cast a vote on a transaction.

proposal-vote --keypair <KEYPAIR_PATH> --multisig-pubkey <MULTISIG_PUBLIC_KEY> --transaction-index <TRANSACTION_INDEX> --action <ACTION> [--memo <MEMO>]

Parameter	Required	Description
`--multisig-pubkey`	Yes	Public key of the multisig account
`--transaction-index`	Yes	Index of the transaction to vote on
`--action`	Yes	Vote action: `Approve`, `Reject`, or `Cancel`
`--memo`	No	Memo for the vote

Examples:

# Approve
proposal-vote --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --transaction-index 1 --action Approve

# Reject
proposal-vote --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --transaction-index 1 --action Reject

# Cancel
proposal-vote --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --transaction-index 1 --action Cancel

vault-transaction-create

Create a new vault transaction with a custom transaction message.

vault-transaction-create --keypair <KEYPAIR_PATH> --multisig-pubkey <MULTISIG_PUBLIC_KEY> --vault-index <VAULT_INDEX> --transaction-message <TRANSACTION_MESSAGE> [--memo <MEMO>]

Parameter	Required	Description
`--multisig-pubkey`	Yes	Public key of the multisig account
`--vault-index`	Yes	Index of the vault
`--transaction-message`	Yes	Transaction message payload
`--memo`	No	Memo for the transaction

vault-transaction-create --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --vault-index 1 \
  --transaction-message 1 --transaction-message 2 --transaction-message 3

vault-transaction-execute

Execute a vault transaction once it’s reached the approval threshold.

vault-transaction-execute --keypair <KEYPAIR_PATH> --multisig-pubkey <MULTISIG_PUBLIC_KEY> --transaction-index <TRANSACTION_INDEX>

Parameter	Required	Description
`--multisig-pubkey`	Yes	Public key of the multisig account
`--transaction-index`	Yes	Index of the transaction to execute

vault-transaction-execute --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --transaction-index 1

vault-transaction-accounts-close

Close the proposal and transaction accounts for a vault transaction. Rent gets returned to the multisig’s rent collector.

vault-transaction-accounts-close --keypair <KEYPAIR_PATH> --multisig-pubkey <MULTISIG_PUBLIC_KEY> --transaction-index <TRANSACTION_INDEX> --rent-collector <RENT_COLLECTOR_PUBKEY>

Parameter	Required	Description
`--multisig-pubkey`	Yes	Public key of the multisig account
`--transaction-index`	Yes	Index of the transaction to close
`--rent-collector`	Yes	Public key for collecting rent

vault-transaction-accounts-close --keypair /path/to/keypair.json \
  --multisig-pubkey <MULTISIG_PUBLIC_KEY> \
  --transaction-index 1 \
  --rent-collector <RENT_COLLECTOR_PUBKEY>

Overview

Getting Started

TypeScript SDK

Reference

API

Resources

Migration Guides

Installation

Wallet support

Global parameters

Commands

multisig-create

config-transaction-create

config-transaction-execute

proposal-vote

vault-transaction-create

vault-transaction-execute

vault-transaction-accounts-close

​Installation

​Wallet support

​Global parameters

​Commands

​multisig-create

​config-transaction-create

​config-transaction-execute

​proposal-vote

​vault-transaction-create

​vault-transaction-execute

​vault-transaction-accounts-close

Installation

Wallet support

Global parameters

Commands

multisig-create

config-transaction-create

config-transaction-execute

proposal-vote

vault-transaction-create

vault-transaction-execute

vault-transaction-accounts-close