Command line interface ​

The command line interface, SmartPy CLI, also known as smartpy-cli, has been introduced in the following outdated Medium Post.

Installation ​

The SmartPy CLI can be installed in two ways: the direct installation or through a project.

Direct Installation ​

To install the current CLI:

bash <(curl -s <[email protected]: ../../site_url-->cli/install.sh)

Project Management ​

See Getting Started/Project Management.

Check version ​

This command tells which CLI version is installed.

~/smartpy-cli/SmartPy.sh --version

Dependencies ​

The SmartPy CLI depends on python3 and Node.js.

It also depends on

• pdoc for Python template documentation.

Execution ​

Executing a SmartPy Script with its tests ​

SmartPy.sh test ​

Perform tests defined in a script (see Tests and Scenarios).

~/smartpy-cli/SmartPy.sh test <script> <output-directory>

This includes many outputs: types, generated michelson code, pretty-printed scenario, etc.

Compiling Contracts and Expressions ​

SmartPy.sh compile ​

Compute the Compilation Targets defined in a script.

# For a SmartPy script:
~/smartpy-cli/SmartPy.sh compile <script> <output-directory>

Example:

# For a SmartPy script:
~/smartpy-cli/SmartPy.sh compile welcome.py /tmp/welcome

Custom Targets ​

SmartPy.sh kind <kind> <script> <output-directory> ​

Similar to tests. Perform scenarios defined in a script introduced by the custom target.

# For a SmartPy script:
~/smartpy-cli/SmartPy.sh kind <kind> <script> <output-directory>

Documentation ​

SmartPy.sh doc <script> <output-directory> ​

Document Python code with pdoc.

Deploying a contract ​

# Using Micheline format (.tz)

~/smartpy-cli/SmartPy.sh originate-contract --code code.tz --storage storage.tz --rpc https://ghostnet.smartpy.io

# Using Michelson format (.json)

~/smartpy-cli/SmartPy.sh originate-contract --code code.json --storage storage.json --rpc https://ghostnet.smartpy.io

# By default, the originator will use a faucet account.
# But you can provide your own private key as an argument

~/smartpy-cli/SmartPy.sh originate-contract --code code.json --storage storage.json --rpc https://ghostnet.smartpy.io --private-key edsk...

CLI optional arguments ​

SmartPy.sh takes several optional arguments.

See Flag for list of flags and protocols.