PyTezos CLI¶
Tutorials¶
Check out this guide by Vadim from Airalab: https://blog.aira.life/tezos-dont-forget-the-mother-console-fd2001261e50?gi=2fe6dfe4fd7f
Examples¶
See how PyTezos CLI is used in a Travis CI pipeline: https://github.com/atomex-me/atomex-fa12-ligo/blob/master/.travis.yml
Reference¶
pytezos¶
pytezos [OPTIONS] COMMAND [ARGS]...
Options
-
--version¶ Show the version and exit.
activate¶
Activate and reveal key from the faucet file
pytezos activate [OPTIONS]
Options
-
-p,--path<path>¶ Path to the .json file downloaded from https://faucet.tzalpha.net/
-
-n,--network<network>¶ Default is florencenet
deploy¶
Deploy contract to the specified network
pytezos deploy [OPTIONS]
Options
-
-p,--path<path>¶ Path to the .tz file
-
--storage<storage>¶ Storage in JSON format (not Micheline)
-
-n,--network<network>¶ Default is florencenet
-
--key<key>¶
-
--github-repo-slug<github_repo_slug>¶
-
--github-oauth-token<github_oauth_token>¶
-
--dry-run<dry_run>¶ Set this flag if you just want to see what would happen
ligo-compile-contract¶
Compile contract using Ligo compiler.
pytezos ligo-compile-contract [OPTIONS]
Options
-
-t,--tag<tag>¶ Version or tag of Ligo compiler
-
-p,--path<path>¶ Path to contract
-
-ep,--entry-point<entry_point>¶ Entrypoint for the invocation
-
-d,--detach<detach>¶ Run container in detached mode
ligo-compile-storage¶
Define initial storage using Ligo compiler.
pytezos ligo-compile-storage [OPTIONS]
Options
-
-t,--tag<tag>¶ Version or tag of Ligo compiler
-
-p,--path<path>¶ Path to contract
-
-ep,--entry-point<entry_point>¶ Entrypoint for the storage
-
-ex,--expression<expression>¶ Expression for the storage
-
-d,--detach<detach>¶ Run container in detached mode
ligo-invoke-contract¶
Invoke a contract with a parameter using Ligo compiler.
pytezos ligo-invoke-contract [OPTIONS]
Options
-
-t,--tag<tag>¶ Version or tag of Ligo compiler
-
-p,--path<path>¶ Path to contract
-
-ep,--entry-point<entry_point>¶ Entrypoint for the invocation
-
-ex,--expression<expression>¶ Expression for the invocation
-
-d,--detach<detach>¶ Run container in detached mode
parameter¶
Manage contract storage
pytezos parameter [OPTIONS]
Options
-
-a,--action<action>¶ One of schema
-
-p,--path<path>¶ Path to the .tz file, or the following uri: <network>:<KT-address>
sandbox¶
Run containerized sandbox node
pytezos sandbox [OPTIONS]
Options
-
--image<image>¶ Docker image to use
-
--protocol<protocol>¶ Protocol to use
- Options
florence | edo
-
-p,--port<port>¶ Port to expose
-
-i,--interval<interval>¶ Interval between baked blocks (in seconds)
-
-b,--blocks<blocks>¶ Number of blocks to bake before exit
smartpy-compile¶
Run SmartPy CLI command “compile”
pytezos smartpy-compile [OPTIONS]
Options
-
-s,--script<script>¶ Path to script
-
-o,--output-directory<output_directory>¶ Output directory
-
-d,--detach<detach>¶ Run container in detached mode
-
--protocol<protocol>¶ Protocol to use
- Options
delphi | edo | florence | proto10
-
-t,--tag<tag>¶ Version or tag of SmartPy to use
smartpy-test¶
Run SmartPy CLI command “test”
pytezos smartpy-test [OPTIONS]
Options
-
-s,--script<script>¶ Path to script
-
-o,--output-directory<output_directory>¶ Output directory
-
--protocol<protocol>¶ Protocol to use
- Options
delphi | edo | florence | proto10
-
-d,--detach<detach>¶ Run container in detached mode
-
-t,--tag<tag>¶ Version or tag of SmartPy to use
storage¶
Manage contract storage
pytezos storage [OPTIONS]
Options
-
-a,--action<action>¶ One of schema, default.
-
-p,--path<path>¶ Path to the .tz file, or the following uri: <network>:<KT-address>