You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

1.7 KiB

layout description permalink
core Blockstack smart contracting language /:collection/:path.html

clarity-cli VM command line

{:.no_toc}

You use the clarity-cli command to work with smart contracts within the Blockstack virtual environment. This command has the following subcommands:

  • TOC {:toc}

initialize

clarity-cli initialize [vm-state.db]

Initializes a local VM state database. If the database exists, this command throws an error.

mine_block

clarity-cli mine_block [block time] [vm-state.db]

Simulates mining a new block.

get_block_height

clarity-cli get_block_height [vm-state.db]

Prints the simulated block height.

check

clarity-cli check [program-file.scm] (vm-state.db)

Type checks a potential contract definition.

launch

clarity-cli launch [contract-identifier] [contract-definition.clar] [vm-state.db]

Launches a new contract in the local VM state database.

eval

clarity-cli eval [contract-identifier] (program.clar) [vm-state.db]

Evaluates, in read-only mode, a program in a given contract context.

eval_raw

clarity-cli eval_raw

Type check and evaluate an expression for validity inside of a function’s source. It does not evaluate within a contract or database context.

repl

clarity-cli repl

Type check and evaluate expressions in a stdin/stdout loop.

execute

clarity-cli execute [vm-state.db] [contract-identifier] [public-function-name] [sender-address] [args...]

Executes a public function of a defined contract.

generate_address

clarity-cli generate_address

Generates a random Stacks public address for testing purposes.