switchboardv2-cli
Advanced tools
command line tool to interact with switchboard v2
npm install -g switchboardv2-cli
sbv2 aggregator:add:job AGGREGATORKEYsbv2 aggregator:create:copy AGGREGATORSOURCE QUEUEKEYsbv2 aggregator:remove:job AGGREGATORKEY JOBKEYsbv2 aggregator:update AGGREGATORKEYsbv2 config:printsbv2 config:set PARAM [VALUE]sbv2 crank:turn CRANKKEYsbv2 job:create:copy JOBSOURCEsbv2 job:create:json JOBDEFINITIONsbv2 job:create:template TEMPLATE IDsbv2 json:add:aggregatorsbv2 json:add:crank SCHEMAFILEsbv2 json:add:oracle SCHEMAFILEsbv2 json:create:aggregator DEFINITIONFILEsbv2 json:create:job DEFINITIONFILEsbv2 json:create:queue INPUTFILE OUTPUTFILEsbv2 oracle:balance ORACLEKEYsbv2 oracle:create QUEUEKEYsbv2 oracle:deposit ORACLEKEY AMOUNTsbv2 oracle:withdraw ORACLEKEY AMOUNTsbv2 print PUBLICKEYsbv2 print:aggregator AGGREGATORKEYsbv2 print:aggregator:lease AGGREGATORKEYsbv2 print:aggregator:permission AGGREGATORKEYsbv2 print:crank CRANKKEYsbv2 print:job JOBKEYsbv2 print:job:templatessbv2 print:json:samples OUTPUTDIRECTORYsbv2 print:mintsbv2 print:oracle ORACLEKEYsbv2 print:oracle:permission ORACLEKEYsbv2 print:programsbv2 print:queue QUEUEKEYsbv2 queue:add:crank QUEUEKEYsbv2 queue:createsbv2 queue:permit:aggregator AGGREGATORKEYsbv2 queue:permit:oracle ORACLEKEYsbv2 update [CHANNEL]sbv2 aggregator:add:job AGGREGATORKEYadd a job account to an aggregator
USAGE
$ sbv2 aggregator:add:job AGGREGATORKEY
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
OPTIONS
-a, --aggregatorAuthority=aggregatorAuthority alternate keypair that is the authority for the aggregator
-f, --outputFile=outputFile output file to save aggregator definition to
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account
authority if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force overwrite outputFile if existing
--jobDefinition=jobDefinition filesystem path of job json definition file
--jobKey=jobKey public key of an existing job account to add to an aggregator
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 aggregator:add:job
See code: src/commands/aggregator/add/job.ts
sbv2 aggregator:create:copy AGGREGATORSOURCE QUEUEKEYcopy an aggregator account to a new oracle queue
USAGE
$ sbv2 aggregator:create:copy AGGREGATORSOURCE QUEUEKEY
ARGUMENTS
AGGREGATORSOURCE public key of the aggregator account to copy
QUEUEKEY public key of the queue to create aggregator for
OPTIONS
-f, --authority=authority output file to save aggregator definition to
-f, --outputFile=outputFile output file to save aggregator definition to
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force skip job confirmation
--mainnetBeta WARNING: use mainnet-beta solana cluster
--outKeypair=outKeypair existing keypair file to store new account. useful for using the same public key on
different clusters
EXAMPLE
$ sbv2 aggregator:create:copy 8SXvChNYFhRq4EZuZvnhjrB3jJRQCv4k3P4W6hesH3Ee
AY3vpUu6v49shWajeFjHjgikYfaBWNJgax8zoEouUDTs --keypair ../payer-keypair.json
See code: src/commands/aggregator/create/copy.ts
sbv2 aggregator:remove:job AGGREGATORKEY JOBKEYremove a switchboard job account from an aggregator
USAGE
$ sbv2 aggregator:remove:job AGGREGATORKEY JOBKEY
ARGUMENTS
AGGREGATORKEY public key of the aggregator account
JOBKEY public key of an existing job account to remove from an aggregator
OPTIONS
-f, --outputFile=outputFile output file to save aggregator definition to
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account
authority if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--aggregatorAuthority=aggregatorAuthority alternate keypair that is the authority for the aggregator
--force overwrite outputFile if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 aggregator:remove:job
See code: src/commands/aggregator/remove/job.ts
sbv2 aggregator:update AGGREGATORKEYrequest a new aggregator result from a set of oracles
USAGE
$ sbv2 aggregator:update AGGREGATORKEY
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 aggregator:update J7j9xX8JP2B2ErvUzuqGAKBGeggsxPyFXj5MqZcYDxfa --keypair ../payer-keypair.json
See code: src/commands/aggregator/update.ts
sbv2 config:printprint cli config
USAGE
$ sbv2 config:print
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 config:print
See code: src/commands/config/print.ts
sbv2 config:set PARAM [VALUE]set a configuration option
USAGE
$ sbv2 config:set PARAM [VALUE]
ARGUMENTS
PARAM (devnet-rpc|mainnet-rpc) configuration parameter to set
VALUE value of the param to set
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-r, --reset remove value or set to default rpc
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
See code: src/commands/config/set.ts
sbv2 crank:turn CRANKKEYturn the crank and get rewarded if aggregator updates available
USAGE
$ sbv2 crank:turn CRANKKEY
ARGUMENTS
CRANKKEY public key of the crank to turn
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 crank:turn 85L2cFUvXaeGQ4HrzP8RJEVCL7WvRrXM2msvEmQ82AVr --keypair ../payer-keypair.json
See code: src/commands/crank/turn.ts
sbv2 job:create:copy JOBSOURCEcopy a job account
USAGE
$ sbv2 job:create:copy JOBSOURCE
ARGUMENTS
JOBSOURCE public key of the aggregator account to copy
OPTIONS
-f, --outputFile=outputFile output file to save job definition to
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force skip job confirmation
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 job:create:copy 7pdb5RVM6cVBU8XDfpGqakb1S4wX2i5QsZxT117tK4HS --keypair ../payer-keypair.json
See code: src/commands/job/create/copy.ts
sbv2 job:create:json JOBDEFINITIONcreate a new on-chain job account from a json file
USAGE
$ sbv2 job:create:json JOBDEFINITION
ARGUMENTS
JOBDEFINITION filesystem path to the json file containing the job definition
OPTIONS
-f, --outputFile=outputFile output file to save job definition to
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=name name of the job account for easier identification
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force skip job confirmation
--mainnetBeta WARNING: use mainnet-beta solana cluster
--outKeypair=outKeypair existing keypair file to store new account. useful for using the same public key on
different clusters
EXAMPLES
$ sbv2 job:create:json examples/job.json --keypair ../payer-keypair.json
$ sbv2 job:create:json examples/job.json --keypair ../payer-keypair.json --name ftxUs_Btc
$ sbv2 job:create:json examples/job.json --keypair ../payer-keypair.json --outKeypair= ftxUs_Btc.json
See code: src/commands/job/create/json.ts
sbv2 job:create:template TEMPLATE IDcreate a new on-chain job account from an existing template
USAGE
$ sbv2 job:create:template TEMPLATE ID
ARGUMENTS
TEMPLATE the template type (ftxUs/coinbase/etc) or the filesystem path to the json file containing the task
definitions
ID api endpoint id for a given source
OPTIONS
-f, --outputFile=outputFile output file to save job definition to
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-k, --outKeypair=outKeypair existing keypair file to store new account. useful for using the same public key on
different clusters
-n, --name=name name of the job account for easier identification
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force skip job confirmation
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLES
$ sbv2 job:create:template ftxUs BTC_USD --keypair ../payer-keypair.json
$ sbv2 job:create:template ftxUs BTC_USD --keypair ../payer-keypair.json --name=ftxUs_Btc
$ sbv2 job:create:template ftxUs BTC_USD -k ../payer-keypair.json -n ftxUs_Btc -f ftx_us_btc_job.json
See code: src/commands/job/create/template.ts
sbv2 json:add:aggregatoradd an aggregator to a schema file
USAGE
$ sbv2 json:add:aggregator
OPTIONS
-a, --authority=authority alternate keypair that is the authority for the oracle queue
-a, --schema=schema filesystem path for an oracle queue schema
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority
if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--aggregatorFile=aggregatorFile filesystem path of job json definition file
--mainnetBeta WARNING: use mainnet-beta solana cluster
--sourceAggregator=sourceAggregator public key of an existing aggregator account to copy
See code: src/commands/json/add/aggregator.ts
sbv2 json:add:crank SCHEMAFILEadd a crank to a schema file
USAGE
$ sbv2 json:add:crank SCHEMAFILE
ARGUMENTS
SCHEMAFILE filesystem path for an oracle queue schema
OPTIONS
-a, --authority=authority alternate keypair that is the authority for the oracle queue
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=name name of the crank for easier identification
-r, --maxRows=maxRows maximum number of rows a crank can support
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
See code: src/commands/json/add/crank.ts
sbv2 json:add:oracle SCHEMAFILEadd an oracle to a schema file
USAGE
$ sbv2 json:add:oracle SCHEMAFILE
ARGUMENTS
SCHEMAFILE filesystem path for an oracle queue schema
OPTIONS
-a, --authority=authority alternate keypair that is the authority for the oracle queue
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=name name of the crank for easier identification
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
See code: src/commands/json/add/oracle.ts
sbv2 json:create:aggregator DEFINITIONFILEcreate an aggregator from a json file
USAGE
$ sbv2 json:create:aggregator DEFINITIONFILE
ARGUMENTS
DEFINITIONFILE filesystem path of queue definition json file
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority
if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--authorityKeypair=authorityKeypair alternate keypair that will be the authority for the aggregator
--force overwrite output file
--mainnetBeta WARNING: use mainnet-beta solana cluster
--outputFile=outputFile output aggregator definition to a json file
--queueKey=queueKey public key of the oracle queue to create aggregator for
ALIASES
$ sbv2 aggregator:create:json
EXAMPLE
$ sbv2 json:create:aggregator examples/aggregator.json ../payer-keypair.json
--queueKey=GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --outputFile=aggregator.schema.json
See code: src/commands/json/create/aggregator.ts
sbv2 json:create:job DEFINITIONFILEcreate a job from a json file
USAGE
$ sbv2 json:create:job DEFINITIONFILE
ARGUMENTS
DEFINITIONFILE filesystem path of job definition json file
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account
authority if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--aggregatorAuthority=aggregatorAuthority filesystem path of aggregator authority keypair to add job account to
--aggregatorKey=aggregatorKey public key of aggregator to add job to
--force overwrite output file
--mainnetBeta WARNING: use mainnet-beta solana cluster
--outputFile=outputFile output job schema to a json file
ALIASES
$ sbv2 job:create:json
EXAMPLE
$ sbv2 json:create:job examples/job.json -k ../payer-keypair.json --aggregatorAuthority=../aggregator-keypair.json
--outputFile=job.schema.json
See code: src/commands/json/create/job.ts
sbv2 json:create:queue INPUTFILE OUTPUTFILEcreate an oracle queue from a json file
USAGE
$ sbv2 json:create:queue INPUTFILE OUTPUTFILE
ARGUMENTS
INPUTFILE filesystem path of queue definition json file
OUTPUTFILE filesystem path of output file to quickly load the queue
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--authority=authority alternate keypair that will be the authority for any created accounts
--force overwrite output file
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 queue:create:json
EXAMPLE
$ sbv2 json:create:queue examples/queue.json queue-1.json -k ../authority-keypair.json
See code: src/commands/json/create/queue.ts
sbv2 oracle:balance ORACLEKEYcheck an oracles token balance
USAGE
$ sbv2 oracle:balance ORACLEKEY
ARGUMENTS
ORACLEKEY public key of the oracle to check token balance
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 oracle:balance 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
See code: src/commands/oracle/balance.ts
sbv2 oracle:create QUEUEKEYcreate a new oracle account for a given queue
USAGE
$ sbv2 oracle:create QUEUEKEY
ARGUMENTS
QUEUEKEY public key of the oracle queue to join
OPTIONS
-a, --authority=authority keypair to delegate authority to for managing the oracle account
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=name name of the oracle for easier identification
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLES
$ sbv2 oracle:create GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --keypair ../payer-and-authority-keypair.json
$ sbv2 oracle:create GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --name=oracle-1 --keypair
../payer-and-authority-keypair.json
$ sbv2 oracle:create GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U --keypair ../payer-keypair.json --authority
../oracle-keypair.json
See code: src/commands/oracle/create.ts
sbv2 oracle:deposit ORACLEKEY AMOUNTdeposit tokens into an oracle's token wallet
USAGE
$ sbv2 oracle:deposit ORACLEKEY AMOUNT
ARGUMENTS
ORACLEKEY public key of the oracle to deposit funds into
AMOUNT amount to deposit into oracle's token wallet
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 oracle:deposit 6kPsQoufdugtHLjM4fH7Z2fNv7jLt5pgvwKHt5JvRhQ6 2500 --keypair ../payer-keypair.json
See code: src/commands/oracle/deposit.ts
sbv2 oracle:withdraw ORACLEKEY AMOUNTwithdraw tokens from an oracle's token wallet
USAGE
$ sbv2 oracle:withdraw ORACLEKEY AMOUNT
ARGUMENTS
ORACLEKEY public key of the oracle to withdraw from
AMOUNT amount to withdraw from oracle's token wallet
OPTIONS
-a, --authority=authority keypair delegated as the authority for managing the oracle account
-f, --force skip minStake balance check. your oracle may be removed from the queue
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account
authority if no alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
-w, --withdrawAccount=withdrawAccount optional solana pubkey or keypair filesystem path to withdraw funds to. default
destination is oracle authority's token wallet
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLES
$ sbv2 oracle:withdraw 6kPsQoufdugtHLjM4fH7Z2fNv7jLt5pgvwKHt5JvRhQ6 2500 --keypair ../oracle-keypair.json
$ sbv2 oracle:withdraw 6kPsQoufdugtHLjM4fH7Z2fNv7jLt5pgvwKHt5JvRhQ6 2500 --keypair ../payer-keypair.json --authority
../oracle-keypair.json -w ByJs8E29jxvqf2KFLwfyiE2gUh5fivaS7aShcRMAsnzg
See code: src/commands/oracle/withdraw.ts
sbv2 print PUBLICKEYfind a switchboard account by public key for a given cluster
USAGE
$ sbv2 print PUBLICKEY
ARGUMENTS
PUBLICKEY public key of a switchboard account to lookup
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 print GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U
See code: src/commands/print/index.ts
sbv2 print:aggregator AGGREGATORKEYPrint the deserialized Switchboard aggregator account
USAGE
$ sbv2 print:aggregator AGGREGATORKEY
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to deserialize
OPTIONS
-f, --outputFile=outputFile output aggregator schema to json file
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force overwrite outputFile if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 aggregator:print
EXAMPLES
$ sbv2 aggregator:print 8SXvChNYFhRq4EZuZvnhjrB3jJRQCv4k3P4W6hesH3Ee
$ sbv2 aggregator:print 8SXvChNYFhRq4EZuZvnhjrB3jJRQCv4k3P4W6hesH3Ee -f btc-usd.json
See code: src/commands/print/aggregator.ts
sbv2 print:aggregator:lease AGGREGATORKEYPrint the lease account associated with a Switchboard aggregator account
USAGE
$ sbv2 print:aggregator:lease AGGREGATORKEY
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to fetch permission account and deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 aggregator:lease:print
EXAMPLE
$ sbv2 aggregator:lease:print 8SXvChNYFhRq4EZuZvnhjrB3jJRQCv4k3P4W6hesH3Ee
See code: src/commands/print/aggregator/lease.ts
sbv2 print:aggregator:permission AGGREGATORKEYPrint the permission account associated with a Switchboard aggregator account
USAGE
$ sbv2 print:aggregator:permission AGGREGATORKEY
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to fetch permission account and deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 aggregator:permission:print
EXAMPLE
$ sbv2 aggregator:permission:print 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
See code: src/commands/print/aggregator/permission.ts
sbv2 print:crank CRANKKEYprint deserialized switchboard crank account
USAGE
$ sbv2 print:crank CRANKKEY
ARGUMENTS
CRANKKEY public key of the crank account to deserialize
OPTIONS
-f, --outputFile=outputFile output aggregator schema to json file
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force overwrite outputFile if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 crank:print
EXAMPLE
$ sbv2 crank:print 85L2cFUvXaeGQ4HrzP8RJEVCL7WvRrXM2msvEmQ82AVr
See code: src/commands/print/crank.ts
sbv2 print:job JOBKEYPrint the deserialized Switchboard job account
USAGE
$ sbv2 print:job JOBKEY
ARGUMENTS
JOBKEY public key of the job account to deserialize
OPTIONS
-f, --outputFile=outputFile output queue json file
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force overwrite outputFile if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 job:print
EXAMPLE
$ sbv2 job:print SzTvFZLz3hwjZFMwVWzuEnr1oUF6qyvXwXCvsqf7qeA
See code: src/commands/print/job.ts
sbv2 print:job:templateslist available templates to build a job from
USAGE
$ sbv2 print:job:templates
ALIASES
$ sbv2 job:print:templates
See code: src/commands/print/job/templates.ts
sbv2 print:json:samples OUTPUTDIRECTORYwrite sample definition files to a directory
USAGE
$ sbv2 print:json:samples OUTPUTDIRECTORY
ARGUMENTS
OUTPUTDIRECTORY filesystem path to output sample definition files
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 json:samples
$ sbv2 write:json:samples
EXAMPLES
$ sbv2 print:json:samples ~/switchboard_json_samples
$ sbv2 json:samples ~/switchboard_json_samples
$ sbv2 write:json:samples ~/switchboard_json_samples
See code: src/commands/print/json/samples.ts
sbv2 print:mintprint switchboard token mint address
USAGE
$ sbv2 print:mint
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 mint:print
EXAMPLE
$ sbv2 print:mint
See code: src/commands/print/mint.ts
sbv2 print:oracle ORACLEKEYPrint the deserialized Switchboard oracle account
USAGE
$ sbv2 print:oracle ORACLEKEY
ARGUMENTS
ORACLEKEY public key of the oracle account to deserialize
OPTIONS
-f, --outputFile=outputFile output aggregator schema to json file
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force overwrite outputFile if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 oracle:print
EXAMPLE
$ sbv2 oracle:print 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
See code: src/commands/print/oracle.ts
sbv2 print:oracle:permission ORACLEKEYPrint the permission account associated with a Switchboard oracle account
USAGE
$ sbv2 print:oracle:permission ORACLEKEY
ARGUMENTS
ORACLEKEY public key of the oracle account to fetch permission account and deserialize
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 oracle:permission:print
EXAMPLE
$ sbv2 oracle:permission:print 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4
See code: src/commands/print/oracle/permission.ts
sbv2 print:programprint the deserialized switchboard program state account
USAGE
$ sbv2 print:program
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 program:print
EXAMPLE
$ sbv2 program:print
See code: src/commands/print/program.ts
sbv2 print:queue QUEUEKEYPrint the deserialized Switchboard oraclequeue account
USAGE
$ sbv2 print:queue QUEUEKEY
ARGUMENTS
QUEUEKEY public key of the oracle queue account to deserialize
OPTIONS
-f, --outputFile=outputFile output queue json file
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force overwrite outputFile if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
ALIASES
$ sbv2 queue:print
EXAMPLE
$ sbv2 queue:print GhYg3R1V6DmJbwuc57qZeoYG6gUuvCotUF1zU3WCj98U
See code: src/commands/print/queue.ts
sbv2 queue:add:crank QUEUEKEYadd a crank to an existing oracle queue
USAGE
$ sbv2 queue:add:crank QUEUEKEY
ARGUMENTS
QUEUEKEY public key of the oracle queue to create a crank on
OPTIONS
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=name name of the crank for easier identification
-r, --maxRows=maxRows maximum number of rows a crank can support
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 queue:add:crank 5aYuxRdcB9GpWrEXVMBQp2R5uf94uoBiFdMEBwcmHuU4 -k ../authority-keypair.json -n crank-1
See code: src/commands/queue/add/crank.ts
sbv2 queue:createcreate an oracle queue
USAGE
$ sbv2 queue:create
OPTIONS
-a, --authority=authority keypair to delegate authority to for creating permissions targeted at the queue
-c, --numCranks=numCranks number of cranks to add to the queue
-f, --outputFile=outputFile output queue schema to a json file
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-n, --name=name name of the queue for easier identification
-o, --numOracles=numOracles number of oracles to add to the queue
-r, --reward=reward oracle rewards for successfully responding to an update request
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--force overwrite output file if existing
--mainnetBeta WARNING: use mainnet-beta solana cluster
--minStake=minStake minimum stake required by an oracle to join the queue
EXAMPLES
$ sbv2 queue:create --keypair ../authority-keypair.json --name queue-1
$ sbv2 queue:create --keypair ../payer-keypair.json --name queue-1 --authority ../authority-keypair.json
$ sbv2 queue:create --keypair ../authority-keypair.json --name queue-1 --numCranks 1 --numOracles 1 --outputFile
new-queue.json
See code: src/commands/queue/create.ts
sbv2 queue:permit:aggregator AGGREGATORKEYpermit an aggregator to use an oracle queue's resources
USAGE
$ sbv2 queue:permit:aggregator AGGREGATORKEY
ARGUMENTS
AGGREGATORKEY public key of the aggregator account to authorize oracle queue usage
OPTIONS
-a, --authority=authority alternate keypair that is the authority for oracle queue
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 queue:permit:aggregator 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4 --keypair ../queue-authority.json
See code: src/commands/queue/permit/aggregator.ts
sbv2 queue:permit:oracle ORACLEKEYpermit an oracle to heartbeat on a queue
USAGE
$ sbv2 queue:permit:oracle ORACLEKEY
ARGUMENTS
ORACLEKEY public key of the oracle account to authorize oracle queue usage
OPTIONS
-a, --authority=authority alternate keypair that is the authority for oracle queue
-h, --help show CLI help
-k, --keypair=keypair keypair that will pay for onchain transactions. defaults to new account authority if no
alternate authority provided
-s, --silent suppress cli prompts
-u, --rpcUrl=rpcUrl alternate RPC url
-v, --verbose log everything
--mainnetBeta WARNING: use mainnet-beta solana cluster
EXAMPLE
$ sbv2 queue:permit:oracle 9CmLriMhykZ8xAoNTSHjHbk6SkuMhie1NCZn9P6LCuZ4 --keypair ../queue-authority.json
See code: src/commands/queue/permit/oracle.ts
sbv2 update [CHANNEL]update the sbv2 CLI
USAGE
$ sbv2 update [CHANNEL]
OPTIONS
--from-local interactively choose an already installed version
See code: @oclif/plugin-update
FAQs
command line tool to interact with switchboard v2
The npm package switchboardv2-cli receives a total of 0 weekly downloads. As such, switchboardv2-cli popularity was classified as not popular.
We found that switchboardv2-cli demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Biome's v2.0 beta introduces custom plugins, domain-specific linting, and type-aware rules while laying groundwork for HTML support and embedded language features in 2025.
Security News
Next.js has patched a critical vulnerability (CVE-2025-29927) that allowed attackers to bypass middleware-based authorization checks in self-hosted apps.
Security News
A survey of 500 cybersecurity pros reveals high pay isn't enough—lack of growth and flexibility is driving attrition and risking organizational security.