CLI 命令参考
' @+ E2 s" V# j6 ~1 P4 X# x              7 ^$ J" ~! U/ M
打开命令行，定位到 NEO-CLI 所在目录，输入下面代码即可启动 NEO 的命令行钱包。6 `* J# d6 f: W
dotnet neo-cli.dll! \! J" q# S9 H. H0 l
本篇教程将介绍命令行钱包的所有命令，你可以通过输入命令的形式操作钱包，如创建打开钱包、导入导出私钥、转账、启动共识等。在命令行中输入 help 可以查看所有命令。) C. n; r/ v# ]( f/ }
Note命令中尖括号  表示参数，方括号 [] 表示可选参数，或符号 | 表示所填的参数可以是其中任意一种，等号 = 表示可选参数在不输入情况下的默认值。3 Y- o0 a1 U. K' m8 W  W
( `, I6 a5 F- ^1 o. k; A$ s
控制台指令* @' S& L/ Y/ e  l

命令	功能说明
version	显示当前软件的版本
help	帮助菜单
clear	清除屏幕
exit	退出程序

% a* v5 d) E0 B钱包操作
4 x8 N/ }. ]8 m: G1 V

命令	功能说明	备注
create wallet	创建钱包文件
open wallet	打开钱包文件
upgrade wallet	升级旧版钱包文件
rebuild index	重建钱包索引	需要打开钱包
list address	列出钱包中的所有账户	需要打开钱包
list asset	列出钱包中的所有资产	需要打开钱包
list key	列出钱包中的所有公钥	需要打开钱包
show utxo [id|alias]	列出钱包中指定资产的 UTXO	需要打开钱包
show gas	列出钱包中的所有可提取及不可提取的 GAS	需要打开钱包
claim gas [all]	提取钱包中可提取状态的 GAS（前50个地址或所有地址）	需要打开钱包
create address [n=1]	创建地址 / 批量创建地址	需要打开钱包
import key	导入私钥 / 批量导入私钥	需要打开钱包
export key [address] [path]	导出私钥	需要打开钱包
send   |all [fee=0]	向指定地址转账 参数分别为：资产 ID，对方地址，转账金额，手续费	需要打开钱包
import multisigaddress m pubkeys...	创建多方签名合约	需要打开钱包
sign	签名  参数为：记录交易内容的 json 字符串	需要打开钱包
relay	广播  参数为：记录交易内容的 json 字符串	需要打开钱包

: D2 ]( p+ b$ M. d- b7 R. a
命令说明: p" d9 v2 C, K7 e/ P1 ~: i: b
👉 upgrade wallet  5 E; `% \% d+ h8 v  E6 ~% t
升级旧版钱包文件- g) P4 k5 T. a" |
neo>upgrade wallet cli.db3
5 B: O* g- ^/ K+ ?+ qWallet file upgrade complete. Old file has been auto-saved at: cli.old.db3  K( V0 F3 r# {3 a3 @
👉 rebuild index
; P( k( k1 W! N: G$ u3 U& C% Z( ?8 D重建钱包索引。为什么要重建钱包索引，重建钱包索引有什么用？
7 k8 _6 z+ P0 y* P" k; C钱包中有一个字段，记录了当前钱包同步的区块高度，每新增加一个区块，钱包客户端就会同步区块，将钱包中的资产和交易更新。假设当前记录的区块高度为 100，然后你执行了 import key 命令导入了私钥，这时钱包仍然是从区块高度为 100开始计算你的资产。如果导入的地址在区块高度小于 100的时候有一些交易，这些交易和对应的资产将不会体现在钱包中，所以要重建钱包索引，强制让钱包从区块高度为0开始计算你的资产。& {1 o& Z& z, R
假如由于种种原因，钱包中的某笔交易未确认，这时资产已经从钱包中扣除，但并未经过整个区块链网络的确认。如果想删掉这笔未确认的交易使钱包中的资产正常显示也需要重建钱包索引。2 Y2 ^6 k; _6 [/ S9 p6 J0 M
新创建的钱包不用重建钱包索引，只有要导入私钥或者钱包中资产显示异常时才需要重建钱包索引。5 N) |" V* \  V6 Q9 @( ^) Y
👉 show utxo [id|alias]
+ D  C7 i- m% g! \8 R# Q列出钱包中指定资产的 UTXO，示例输出如下所示：
$ n. @2 `% r4 a5 o" C% K2 a5 {neo>show utxo neo9 \) }* G& L; S( c" b- m
8674c38082e59455cf35cee94a5a1f39f73b617b3093859aa199c756f7900f1f:23 {# l7 O) P' X
total: 1 UTXOs
4 x! r) l' o2 cneo>show utxo gas* B. V1 p: \- g4 v& Z5 g3 Z$ J
8674c38082e59455cf35cee94a5a1f39f73b617b3093859aa199c756f7900f1f:1& k" |' O: c5 [. E* m8 Q
total: 1 UTXOs
+ w5 g$ P1 K$ `( q' lneo>show utxo 025d82f7b00a9ff1cfe709abe3c4741a105d067178e645bc3ebad9bc79af47d4* ^$ t1 b2 t7 M: b$ P
8674c38082e59455cf35cee94a5a1f39f73b617b3093859aa199c756f7900f1f:0
. O9 Y% O. o. \2 _. r  I/ `6 s9 x! qtotal: 1 UTXOs0 w: h2 [$ s+ f+ T: U9 U; L
👉 show gas
* |0 J  o) }& S. Y列出钱包中的所有可提取及不可提取的 GAS，输出结果如下：% M. \! a: F" c' l$ ?! W5 _
unavailable: 133.024
" C$ G7 T: V( r, F  available: 10.123
: H2 ~3 ^, j+ j" ~3 j; {4 _其中 unavailable 表示不可提取的 GAS，available 表示可提取（待提取）的 GAS。
2 o& o& K: H  }# U+ |

注：这里不包含已提取的 GAS，查看已提取的 GAS 请用 list asset 命令。! |  W6 a5 H4 K: E

- j! q0 E  f% s! O' Z: f什么是可提取的 GAS，什么是不可提取的 GAS？
9 @+ g+ }+ \/ S每一个 NEO 都有两种状态：unspent 和 spent。每一个未提取的 GAS 也有两种状态，available 和 unavailable。一个 NEO 的生命周期以转入地址起始，转出地址截止，转入时状态变为 unspent，转出时状态变为 spent。当 NEO 处于 unspent 状态时，所产生的 Gas 为 unavailable 状态，即不可提取。当 NEO 处于 spent 状态时，期间所产生的 GAS 变为 available，用户可以提取。
7 j* `& T/ }7 x如何将钱包中的所有 unavailable GAS 转为 available GAS 呢，很简单，将钱包中的所有 NEO 转到钱包中的任意一个地址即可。6 ~# Q' y' y: B* r' {4 N% h
👉 claim gas
  Z8 A+ w* }. t% C$ }* ?, v* M提取钱包中可提取状态下的 GAS，该过程是通过一个特殊的交易 Claim Transaction 完成的，输入命令后，客户端会输出 Claim Transaction 的 ID（提取 GAS 这笔交易的 ID）。用户可以有两种选择，如末尾不带参数，则默认提取钱包前50个地址中的可提取状态的 GAS。如果指定参数 [all]，则会提取钱包中所有地址的可提取状态的 GAS。
9 ~; j. ]$ C7 T2 @# S执行完 claim gas 命令后，再执行 list asset 会显示 GAS 有增加。
+ C$ h, K! I/ c6 s9 @4 h👉 create address [n=1] 4 V# |: O- m2 G. \) Q4 U6 O6 i
可以输入 create address  来创建一个地址，也可以输入 create address 100 来批量创建 100个地址，批量创建的地址会自动导出到 address.txt 文件中。: v7 D: ^! C  V' k4 s: ^
👉 export key [address] [path]
+ ?$ S. m7 J' u& V$ d* S; B$ ^你可以指定导出哪个地址对应的私钥，也可以指定导出至指定的文件中，例如下面的命令都是合法的。该命令需要验证钱包密码。! [+ J, X, _* ~8 f8 d
export key' @7 h; }6 Y$ C. E  @, O
export key AeSHyuirtXbfZbFik6SiBW2BEj7GK3N62b
" ^+ H; v* S$ t3 sexport key key.txt
$ k' l: N! q! H, R* f1 h* D5 {export key AeSHyuirtXbfZbFik6SiBW2BEj7GK3N62b key.txt# P8 f  I0 c0 R3 Z5 Y+ S
👉  import key
+ Q- m) }( L% l5 }导入私钥，你可以指定导入一个私钥，或者是导入一个文件中的多个私钥，例如下面的命令都是合法的。
6 h6 U+ O! o% zimport key L4zRFphDJpLzXZzYrYKvUoz1LkhZprS5pTYywFqTJT2EcmWPPpPH
5 D8 m3 f+ Z& g. A3 n. i5 N; ^import key key.txt
( Q4 j% A9 }. c# d4 {如果是指定文件的话，文件里的私钥格式请参考 export key key.txt 的输出。
3 [4 d/ A1 c* |) F4 @: Q👉 send   |all [fee=0]1 S8 {9 n- s$ A8 K, S$ i" z
转账，一共有 4 个参数，第一个参数是资产 ID，第二个参数是收款地址，第三个参数是转账金额（当输入 all 即为钱包中该资产的全部数量），第四个参数是手续费（这个参数可不填，默认为0）。该命令需要验证钱包密码。假如我想转 100 NEO 转到这个地址“AeSHyuirtXbfZbFik6SiBW2BEj7GK3N62b”，我需要输入以下命令。
- ^2 u1 ?; R! Ksend c56f33fc6ecfcd0c225c4ab356fee59390af8560be0e930faebe74a6daff7c9b AeSHyuirtXbfZbFik6SiBW2BEj7GK3N62b 100( h) S5 i) M3 G8 b: `
因为第二个参数除了资产 ID，还可以填写资产缩写，如 neo，gas，所以以上命令可以写成：. n; w. x/ }. P
send neo AeSHyuirtXbfZbFik6SiBW2BEj7GK3N62b 100
# @8 z+ u) o9 x* Z/ n) i) Q不知道资产 ID 怎么办？请输入 list asset 命令查看钱包中的所有资产。
# L* M3 T" Q1 d, f7 Y5 Z& D👉 import multisigaddress m pubkeys...5 u( C7 `. y; Q0 G3 _
以 m 个最小签名数量来创建多方签名的合约地址，例如两个公钥创建的多方签名地址， m 可以为 1 或 2， 后面的参数就是两方的公钥。
* f: Y6 y9 a' B  k例如：import multisigaddress 1 037ebe29fff57d8c177870e9d9eecb046b27fc290ccbac88a0e3da8bac5daa630d 03b34a4be80db4a38f62bb41d63f9b1cb664e5e0416c1ac39db605a8e30ef270cc. I7 U- N8 M) v7 w. L2 B# ?
👉 sign  # q  z* f; z0 L+ P( R/ _5 l
从签名数量为 1 以上的多方签名合约中提取资产时，需要多方进行签名，参数为记录这段交易的 json 字符串。 签名完整后才能广播出去。
( _, a& R; u3 ^5 }👉 relay  
; ^3 n- D6 v- {; X签名完整后，可以将这段交易信息进行广播。参数同样为记录这段交易的 json 字符串。* v4 r1 V; d; i9 D# ^5 x
插件安装! w' ?) @/ Z! _% H& g3 Q9 U: e

命令	功能说明	备注
install [Plugin name]	安装指定插件
uninstall [Plugin name]	卸载指定插件

8 _) a8 j: h  S7 b+ ]! c1 U命令说明
+ q+ Q) w+ T9 F$ i👉 install [Plugin name]
+ K, o) W! n8 s4 }- U安装指定插件，如下所示。卸载插件与此类似。2 h% {  W- E# @# S# j6 `5 D3 N+ y
neo>install ImportBlocks) \5 C* D% j" o( y: C4 M
Downloading from https://github.com/neo-project/neo-plugins/releases/download/v2.9.4/ImportBlocks.zip2 V; b6 c8 q; [
Install successful, please restart neo-cli.
( c7 O$ X% y" [2 b: u( o" gneo>install ApplicationLogs
4 g2 Y3 Z6 |: m8 c7 ~' d7 [! PDownloading from https://github.com/neo-project/neo-plugins/releases/download/v2.9.4/ApplicationLogs.zip
  o9 Z# y2 l, ~; q* W/ d9 M& oInstall successful, please restart neo-cli.  f; |2 ?* Z6 N
以上只是示例插件，更多插件请访问 NEO 客户端插件。; x1 \! t4 W1 `* c; @
查看节点信息
6 f2 m3 ]/ a/ Q

命令	功能说明
show state	显示当前区块链同步状态
show node	显示当前已连接的节点地址和端口
show pool	显示内存池中的交易（这些交易处于零确认的状态）
export blocks [path=chain.acc]	导出全部区块数据，导出的结果可以用作离线同步
export blocks  [count]	从指定区块高度导出指定数量的区块数据，导出的结果可以用作离线同步

, |8 C' d, Z9 E5 q* W3 u4 x- @; v高级指令+ [2 I$ U+ ?* j  ]0 D% _) t

命令	功能说明
start consensus	启动共识

6 x6 y; ?7 T4 H; w+ g/ J启动共识的前提是该钱包有共识的权限，在 NEO 主网上可以通过投票选举获得共识的权限，如果自己部署的私有链可以在 protocol.json 中设置共识节点的公钥，详情可参考 私链搭建。