· 7 years ago · Jul 03, 2018, 03:28 PM
1Usage:
2 tezos-client [global options] command [command options]
3 tezos-client --help (for global options)
4 tezos-client [global options] command --help (for command options)
5
6To browse the documentation:
7 tezos-client [global options] man (for a list of commands)
8 tezos-client [global options] man -v 3 (for the full manual)
9
10Global options (must come before the command):
11 -d --base-dir <path>: client data directory
12 -c --config-file <path>: configuration file
13 -t --timings: show RPC request times
14 -b --block <hash|tag>: block on which to apply contextual commands
15 -w --wait <none|<int>>: how many confirmation blocks before to consider an operation as included
16 -p --protocol <hash>: use commands of a specific protocol
17 -l --log-requests: log all requests to the node
18 -A --addr <IP addr|host>: IP address of the node
19 -P --port <number>: RPC port of the node
20 -S --tls: use TLS to connect to node.
21 -R --remote-signer <uri>: URI of the remote signer
22
23Access the documentation:
24 man [<keyword>...] [-v --verbosity <0|1|2|3>]
25 [--format <plain|colors|html>]
26 Print documentation of commands.
27 <keyword>: keyword to search for
28 -v --verbosity <0|1|2|3>: level of details
29 --format <plain|colors|html>: the manual's output format
30
31Binary Description:
32 describe unsigned block header
33 Describe unsigned block header
34 describe unsigned operation
35 Describe unsigned block header
36
37Block contextual commands (see option -block):
38 get timestamp [-s --seconds]
39 Access the timestamp of the block.
40 -s --seconds: output time in seconds
41 list contracts
42 Lists all non empty contracts of the block.
43 get balance for <src>
44 Get the balance of a contract.
45 <src>: source contract
46 get script storage for <src>
47 Get the storage of a contract.
48 <src>: source contract
49 get script code for <src>
50 Get the storage of a contract.
51 <src>: source contract
52 get manager for <src>
53 Get the manager of a contract.
54 <src>: source contract
55 get delegate for <src>
56 Get the delegate of a contract.
57 <src>: source contract
58 set delegate for <src> to <mgr> [--fee <amount>] [-D --dry-run]
59 Set the delegate of a contract.
60 <src>: source contract
61 <mgr>: new delegate of the contract
62 --fee <amount>: fee in ꜩ to pay to the baker
63 -D --dry-run: don't inject the operation, just display it
64 withdraw delegate from <src> [--fee <amount>] [-D --dry-run]
65 Withdraw the delegate from a contract.
66 <src>: source contract
67 --fee <amount>: fee in ꜩ to pay to the baker
68 -D --dry-run: don't inject the operation, just display it
69 originate account <new> for <mgr> transferring <qty> from <src> [--fee <amount>]
70 [-D --dry-run] [--delegate <address>] [--delegatable] [-f --force]
71 Open a new account.
72 <new>: name of the new contract
73 <mgr>: manager of the new contract
74 <qty>: amount taken from source in ꜩ
75 <src>: name of the source contract
76 --fee <amount>: fee in ꜩ to pay to the baker
77 -D --dry-run: don't inject the operation, just display it
78 --delegate <address>: delegate of the contract
79 --delegatable: allow future delegate change
80 -f --force: overwrite existing keys
81 originate contract <new> for <mgr> transferring <qty> from <src> running <prg> [--fee <amount>]
82 [-D --dry-run] [-G --gas-limit <amount>] [-S --storage-limit <amount>]
83 [--delegate <address>] [-f --force] [--delegatable] [--spendable]
84 [--init <data>] [-q --no-print-source]
85 Launch a smart contract on the blockchain.
86 <new>: name of the new contract
87 <mgr>: manager of the new contract
88 <qty>: amount taken from source in ꜩ
89 <src>: name of the source contract
90 <prg>: script of the account
91 --fee <amount>: fee in ꜩ to pay to the baker
92 -D --dry-run: don't inject the operation, just display it
93 -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
94 -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
95 --delegate <address>: delegate of the contract
96 -f --force: overwrite existing keys
97 --delegatable: allow future delegate change
98 --spendable: allow the manager to spend the contract's tokens
99 --init <data>: initial value of the contract's storage
100 -q --no-print-source: don't print the source code
101 transfer <qty> from <src> to <dst> [--fee <amount>] [-D --dry-run]
102 [-G --gas-limit <amount>] [-S --storage-limit <amount>] [--arg <data>]
103 [-q --no-print-source]
104 Transfer tokens / call a smart contract.
105 <qty>: amount taken from source in ꜩ
106 <src>: name of the source contract
107 <dst>: name/literal of the destination contract
108 --fee <amount>: fee in ꜩ to pay to the baker
109 -D --dry-run: don't inject the operation, just display it
110 -G --gas-limit <amount>: Set the gas limit of the transaction instead of letting the client decide based on a simulation
111 -S --storage-limit <amount>: Set the storage limit of the transaction instead of letting the client decide based on a simulation
112 --arg <data>: argument passed to the contract's script, if needed
113 -q --no-print-source: don't print the source code
114 reveal key for <src> [--fee <amount>]
115 Reveal the public key of the contract manager.
116 <src>: name of the source contract
117 --fee <amount>: fee in ꜩ to pay to the baker
118 register key <mgr> as delegate [--fee <amount>] [-D --dry-run]
119 Register the public key hash as a delegate.
120 <mgr>: the delegate key
121 --fee <amount>: fee in ꜩ to pay to the baker
122 -D --dry-run: don't inject the operation, just display it
123 activate fundraiser account <name> with <code> [-D --dry-run]
124 Activate a fundraiser account.
125 <name>: existing public key hash alias
126 <code>: Activation code obtained from the Tezos foundation.
127 -D --dry-run: don't inject the operation, just display it
128
129Commands for managing the record of known contracts:
130 remember contract <new> <src> [-f --force]
131 Add a contract to the wallet.
132 <new>: new contract alias
133 <src>: source contract
134 -f --force: overwrite existing contract
135 forget contract <name>
136 Remove a contract from the wallet.
137 <name>: existing contract alias
138 list known contracts
139 Lists all known contracts in the wallet.
140 forget all contracts [-f --force]
141 Forget the entire wallet of known contracts.
142 -f --force: overwrite existing contract
143 show known contract <name>
144 Display a contract from the wallet.
145 <name>: existing contract alias
146
147Commands for managing the library of known scripts:
148 list known scripts
149 Lists all scripts in the library.
150 remember script <new> <src> [-f --force]
151 Add a script to the library.
152 <new>: new script alias
153 <src>: source script
154 -f --force: overwrite existing script
155 forget script <name>
156 Remove a script from the library.
157 <name>: existing script alias
158 show known script <name>
159 Display a script from the library.
160 <name>: existing script alias
161 run script <src> on storage <storage> and input <storage> [--trace-stack]
162 [--amount <amount>] [-q --no-print-source]
163 Ask the node to run a script.
164 <src>: source script
165 <storage>: the storage data
166 <storage>: the input data
167 --trace-stack: show the stack after each step
168 --amount <amount>: amount of the transfer in ꜩ
169 -q --no-print-source: don't print the source code
170 typecheck script <src> [-v --details] [--emacs] [-q --no-print-source]
171 [-G --gas <gas>]
172 Ask the node to typecheck a script.
173 <src>: source script
174 -v --details: show the types of each instruction
175 --emacs: output in `michelson-mode.el` compatible format
176 -q --no-print-source: don't print the source code
177 -G --gas <gas>: Initial quantity of gas for typechecking and execution
178 typecheck data <data> against type <type> [-q --no-print-source]
179 [-G --gas <gas>]
180 Ask the node to typecheck a data expression.
181 <data>: the data to typecheck
182 <type>: the expected type
183 -q --no-print-source: don't print the source code
184 -G --gas <gas>: Initial quantity of gas for typechecking and execution
185 hash data <data> of type <type> [-G --gas <gas>]
186 Ask the node to pack a data expression.
187 <data>: the data to hash
188 <type>: type of the data
189 -G --gas <gas>: Initial quantity of gas for typechecking and execution
190 sign bytes <data> for <src>
191 Sign a raw sequence of bytes and display it using the format expected by Michelson instruction `CHECK_SIGNATURE`.
192 <data>: the raw data to sign
193 <src>: source secret_key
194 check that <bytes> was signed by <key> to produce <signature> [-q --quiet]
195 Check the signature of a byte sequence as per Michelson instruction `CHECK_SIGNATURE`.
196 <bytes>: the signed data
197 <key>: existing public_key alias
198 <signature>: the signature to check
199 -q --quiet: Use only exit codes
200
201Commands related to delegate operations.:
202 bake for <baker> [--max-priority <slot>] [--fee-threshold <threshold>]
203 [-f --force] [--minimal-timestamp]
204 Forge and inject block using the delegate rights.
205 <baker>: name of the delegate owning the baking right
206 --max-priority <slot>: maximum allowed baking slot
207 --fee-threshold <threshold>: exclude operations with fees lower than this threshold (in mutez)
208 -f --force: disables the node's injection checks
209 --minimal-timestamp: Use the minimal timestamp instead of the current date as timestamp of the baked block.
210 reveal nonce for [<block_hash>...]
211 Forge and inject a seed-nonce revelation operation.
212 <block_hash>: A block identifier
213 reveal nonces
214 Forge and inject all the possible seed-nonce revelation operations.
215 endorse for <baker>
216 Forge and inject an endorsement operation.
217 <baker>: name of the delegate owning the endorsement right
218
219Commands for managing the wallet of cryptographic keys:
220 list signing schemes
221 List supported signing schemes.
222 gen keys <new> [-f --force] [-s --sig <ed25519|secp256k1|p256>]
223 Generate a pair of keys.
224 <new>: new secret_key alias
225 -f --force: overwrite existing secret_key
226 -s --sig <ed25519|secp256k1|p256>: use custom signature algorithm
227 gen vanity keys <new> matching [<words>...] [-P --prefix] [-f --force]
228 Generate keys including the given string.
229 <new>: new public key hash alias
230 <words>: string key must contain one of these words
231 -P --prefix: the key must begin with tz1[word]
232 -f --force: overwrite existing keys
233 import secret key <new> <uri> [-f --force]
234 Add a secret key to the wallet.
235 <new>: new secret_key alias
236 <uri>: secret key
237 -f --force: overwrite existing secret_key
238 import fundraiser secret key <new> [-f --force]
239 Add a fundraiser secret key to the wallet.
240 <new>: new secret_key alias
241 -f --force: overwrite existing secret_key
242 import public key <new> <uri> [-f --force]
243 Add a public key to the wallet.
244 <new>: new public_key alias
245 <uri>: public key
246 -f --force: overwrite existing public_key
247 add address <new> <src> [-f --force]
248 Add an address to the wallet.
249 <new>: new public key hash alias
250 <src>: source public key hash
251 -f --force: overwrite existing public_key
252 list known addresses
253 List all addresses and associated keys.
254 show address <name> [-S --show-secret]
255 Show the keys associated with an implicit account.
256 <name>: existing public key hash alias
257 -S --show-secret: show the private key
258 forget address <name> [-f --force]
259 Forget one address.
260 <name>: existing public key hash alias
261 -f --force: delete associated keys when present
262 forget all keys [-f --force]
263 Forget the entire wallet of keys.
264 -f --force: you got to use the force for that
265
266Commands for managing the connected Ledger Nano S devices:
267 list connected ledgers
268 List supported Ledger Nano S devices connected.
269 show ledger path <uri>
270 Show BIP32 derivation at path for Ledger
271 <uri>: secret key
272 authorize ledger to bake for <name>
273 Authorize a Ledger to bake for a key
274 <name>: existing public_key alias
275 get ledger high watermark for <uri>
276 Get high water mark of a Ledger
277 <uri>: secret key
278 set ledger high watermark for <uri> to <high watermark>
279 Set high water mark of a Ledger
280 <uri>: secret key
281 <high watermark>: High watermark
282
283Commands for the low level RPC layer:
284 rpc list <url>
285 List RPCs under a given URL prefix.
286 <url>: the URL prefix
287 rpc list
288 Alias to `rpc list /`.
289 rpc schema <HTTP method> <url>
290 Get the input and output JSON schemas of an RPC.
291 <HTTP method>:
292 <url>: the RPC url
293 rpc format <HTTP method> <url> [-b --binary]
294 Get the humanoid readable input and output formats of an RPC.
295 <HTTP method>:
296 <url>: the RPC URL
297 -b --binary: Binary format
298 rpc get <url>
299 Call an RPC with the GET method.
300 <url>: the RPC URL
301 rpc post <url>
302 Call an RPC with the POST method.
303 <url>: the RPC URL
304 rpc post <url> with <input>
305 Call an RPC with the POST method, providing input data via the command line.
306 <url>: the RPC URL
307 <input>: the raw JSON input to the RPC
308
309Commands for editing and viewing the client's config file:
310 config show
311 Show the config file.
312 config reset
313 Reset the config file to the factory defaults.
314 config update
315 Update the config based on the current cli values.
316 config init [-o --output <path>]
317 Create a config file based on the current CLI values.
318 -o --output <path>: path at which to create the file
319
320Miscellaneous commands:
321 list understood protocols
322 List the protocol versions that this client understands.
323 complete <prefix> [-u --unique]
324 Autocomplete a prefix of Base58Check-encoded hash.
325 <prefix>: the prefix of the hash to complete
326 -u --unique: Fail when there is more than one possible completion.
327 bootstrapped
328 Wait for the node to be bootstrapped.
329 wait for <operation> to be included [---confirmations <num_blocks>]
330 [---check-previous <num_blocks>]
331 Wait until an operation is included in a block
332 <operation>: Operation to be included
333 ---confirmations <num_blocks>: do not end until after 'N' additional blocks after the operation appears
334 ---check-previous <num_blocks>: number of previous blocks to check