@arcblock/forge-cli
a general set of CLI for arcblock Forge framework
Last updated a month ago by wangshijun .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @arcblock/forge-cli 
SYNC missed versions from official npm registry.

forge-cli

Command line toolbox maintained by Arcblock that helps developers to work with Forge SDK

Table of Contents

Introduction

docs Build Status PRs Welcome Gitter

forge-cli is an awesome toolbox for developers to work with forge, and forge is an awesome framework for building decentralized applications. Out of the box forge-cli support following features:

  • Manage forge kernel release
  • Manage local forge node, join a remote forge powered network
  • Create wallets and accounts on blockchain
  • Read/subscribe accounts/blocks/transactions/assets on blockchain
  • Send transactions to the blockchain
  • Use forge components such as forge-web
  • Compile and deploy transaction protocol
  • Do stake to node/user/asset
  • Bootstrap dApps with starters from here

Requirements

  • Linux/Mac Command Line, windows is not support currently, iTerm is recommended.
  • Node.js: please install using nvm, >= v10 && <= v12.x

QuickStart

asciicast

Install

npm install -g @arcblock/forge-cli
# OR
yarn global add @arcblock/forge-cli

Now forge command is available to all new shell sessions.

Usage

Run forge and get available options and subcommands.

❯ forge

██████╗ ██╗   ██╗     █████╗ ██████╗  ██████╗██████╗ ██╗      ██████╗  ██████╗██╗  ██╗
██╔══██╗╚██╗ ██╔╝    ██╔══██╗██╔══██╗██╔════╝██╔══██╗██║     ██╔═══██╗██╔════╝██║ ██╔╝
██████╔╝ ╚████╔╝     ███████║██████╔╝██║     ██████╔╝██║     ██║   ██║██║     █████╔╝ 
██╔══██╗  ╚██╔╝      ██╔══██║██╔══██╗██║     ██╔══██╗██║     ██║   ██║██║     ██╔═██╗ 
██████╔╝   ██║       ██║  ██║██║  ██║╚██████╗██████╔╝███████╗╚██████╔╝╚██████╗██║  ██╗
╚═════╝    ╚═╝       ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝╚═════╝ ╚══════╝ ╚═════╝  ╚═════╝╚═╝  ╚═╝
                                                                                      
Usage: forge [options] [command]

Options:
  -V, --version                    output the version number
  -v, --verbose                    Output runtime info when execute subcommand, useful for debug
  -c, --chain-name <chainName>     Execute command use specific chain
  -i, --config-path <path>         Forge config used when starting forge node and initializing gRPC clients
  -r, --npm-registry <registry>    Specify a custom npm registry
  -y, --yes                        Assume that the answer to any confirmation question is yes
  -d, --defaults                   Run command using default values for all questions
  -m, --mirror <url>               Mirror host used to download forge release
  -g, --socket-grpc <endpoint>     Socket gRPC endpoint to connect, with this you can use forge-cli with a remote node
  -h, --help                       output usage information

Commands:
  account <address>                Get an account info by address
  asset <address>                  Get asset info by address
  block [options] [height]         Get the block info from the running node
  blocklet:init [options]          Init a blocklet project
  blocklet:use [options]           Download and install a blocklet
  chain:config [options] [action]  Read/write chain/node config
  chain:create [chainName]         Create a new chain instance
  chain:ls                         List all chains
  chain:remove <chainName>         Remove chain state and config
  chain:reset <chainName>          Reset chain state, but keeps the config
  chain:validator [options]        Update(add, remove, change) or list validators
  config [options] [key] [value]   Config forge cli configs
  declare:node [options]           Declare the current node to be a validator candidate
  deploy:prepare [options]         Prepare node for deploying a multi-node chain
  download [options] [version]     Download a forge release without activate it
  help [subcommand]                Show help of a sub command
  install [options] [version]      Download and setup forge release on this machine
  join <endpoint>                  Join a network by providing a valid forge web graphql endpoint
  logs [type]                      Show logs for various forge components
  ls                               List forge releases installed locally
  ls:remote                        List remote forge releases available for install
  ps                               List running forge component processes
  remote [shellName]               Connects to the running system via a remote shell
  simulator [action]               Start/stop simulator and generate random traffic
  start [options] [<chainName>]    Start the forge and forge web deamon
  status [type]                    List info of the running chain/node
  stop [options] [<chainName>]     Stop the forge daemon and all related services
  tx [hash]                        Get a tx detail and display
  tx:ls                            List latest transactions
  upgrade [<chainName>]            Upgrade chain node to new version without reset
  use [version]                    Activate an already downloaded forge release
  version [<chainName>]            Output version for all forge components
  wallet:create                    Create a local wallet and dump its public/private key
  web [action]                     Open the web interface of running forge chain/node

Examples:

  Please install a forge-release before running any other commands
  > forge install latest
  > forge install --mirror https://releases.arcblockio.cn

  Curious about how to use a subcommand?
  > forge help install
  

FAQ

Checkout FAQ.md

Current Tags

  • 1.2.2                                ...           latest (a month ago)
  • 1.1.0-beta.2                                ...           next (2 months ago)

279 Versions

  • 1.2.2                                ...           a month ago
  • 1.2.1                                ...           2 months ago
  • 1.2.0                                ...           2 months ago
  • 1.1.3                                ...           2 months ago
  • 1.1.2                                ...           2 months ago
  • 1.1.1                                ...           2 months ago
  • 1.1.0                                ...           2 months ago
  • 1.1.0-beta.2                                ...           2 months ago
  • 1.1.0-beta.1                                ...           2 months ago
  • 1.0.17                                ...           2 months ago
  • 1.0.16                                ...           2 months ago
  • 1.0.15                                ...           3 months ago
  • 1.0.14                                ...           3 months ago
  • 1.0.13                                ...           3 months ago
  • 1.0.12                                ...           5 months ago
  • 1.0.11                                ...           6 months ago
  • 1.0.10                                ...           6 months ago
  • 1.0.9-beta                                ...           6 months ago
  • 1.0.9                                ...           6 months ago
  • 1.0.6                                ...           6 months ago
  • 1.0.5                                ...           6 months ago
  • 1.0.4                                ...           6 months ago
  • 1.0.3                                ...           6 months ago
  • 1.0.2                                ...           6 months ago
  • 1.0.1                                ...           6 months ago
  • 1.0.0                                ...           6 months ago
  • 1.0.0-beta1                                ...           6 months ago
  • 0.40.7                                ...           7 months ago
  • 0.40.6                                ...           7 months ago
  • 0.40.6-alpha2                                ...           7 months ago
  • 0.40.6-alpha1                                ...           7 months ago
  • 0.40.5                                ...           7 months ago
  • 0.40.5-beta3                                ...           7 months ago
  • 0.40.5-beta2                                ...           7 months ago
  • 0.40.5-beta1                                ...           7 months ago
  • 0.40.4                                ...           7 months ago
  • 0.40.3                                ...           7 months ago
  • 0.40.2                                ...           7 months ago
  • 0.40.1                                ...           7 months ago
  • 0.40.0                                ...           7 months ago
  • 0.39.28                                ...           7 months ago
  • 0.39.27                                ...           7 months ago
  • 0.39.26                                ...           7 months ago
  • 0.39.25                                ...           7 months ago
  • 0.39.24                                ...           7 months ago
  • 0.39.23                                ...           7 months ago
  • 0.39.22                                ...           7 months ago
  • 0.39.21-beta.1                                ...           7 months ago
  • 0.39.21                                ...           7 months ago
  • 0.39.20                                ...           7 months ago
  • 0.39.19                                ...           7 months ago
  • 0.39.18                                ...           7 months ago
  • 0.39.17                                ...           7 months ago
  • 0.39.16                                ...           7 months ago
  • 0.39.15                                ...           7 months ago
  • 0.39.14                                ...           7 months ago
  • 0.39.13                                ...           7 months ago
  • 0.39.12                                ...           7 months ago
  • 0.39.11                                ...           7 months ago
  • 0.39.10                                ...           7 months ago
  • 0.39.9                                ...           7 months ago
  • 0.39.8                                ...           8 months ago
  • 0.39.7                                ...           8 months ago
  • 0.39.6                                ...           8 months ago
  • 0.39.5                                ...           8 months ago
  • 0.39.4                                ...           8 months ago
  • 0.39.3                                ...           8 months ago
  • 0.39.2                                ...           8 months ago
  • 0.39.1                                ...           8 months ago
  • 0.39.0                                ...           8 months ago
  • 0.38.28                                ...           8 months ago
  • 0.38.27                                ...           8 months ago
  • 0.38.26                                ...           8 months ago
  • 0.38.26-beta1                                ...           8 months ago
  • 0.38.25                                ...           8 months ago
  • 0.38.25-beta1                                ...           8 months ago
  • 0.38.24                                ...           8 months ago
  • 0.38.23                                ...           8 months ago
  • 0.38.22                                ...           8 months ago
  • 0.38.21                                ...           8 months ago
  • 0.38.20                                ...           8 months ago
  • 0.38.19                                ...           8 months ago
  • 0.38.18                                ...           8 months ago
  • 0.38.17                                ...           8 months ago
  • 0.38.16                                ...           8 months ago
  • 0.38.16-beta.1                                ...           8 months ago
  • 0.38.15                                ...           8 months ago
  • 0.38.14                                ...           8 months ago
  • 0.38.14-beta1                                ...           8 months ago
  • 0.38.13                                ...           8 months ago
  • 0.38.12                                ...           8 months ago
  • 0.38.12-beta.2                                ...           8 months ago
  • 0.38.11                                ...           8 months ago
  • 0.38.11-beta.1                                ...           8 months ago
  • 0.38.10                                ...           8 months ago
  • 0.38.9                                ...           8 months ago
  • 0.38.8                                ...           9 months ago
  • 0.38.7                                ...           9 months ago
  • 0.38.6                                ...           9 months ago
  • 0.38.5                                ...           9 months ago
  • 0.38.4                                ...           9 months ago
  • 0.38.3                                ...           9 months ago
  • 0.38.2                                ...           9 months ago
  • 0.38.1                                ...           9 months ago
  • 0.38.0                                ...           9 months ago
  • 0.37.10                                ...           9 months ago
  • 0.37.9                                ...           9 months ago
  • 0.37.8                                ...           9 months ago
  • 0.37.7                                ...           9 months ago
  • 0.37.6                                ...           9 months ago
  • 0.37.5                                ...           9 months ago
  • 0.37.4                                ...           9 months ago
  • 0.37.3                                ...           9 months ago
  • 0.37.2                                ...           9 months ago
  • 0.37.1                                ...           9 months ago
  • 0.37.0                                ...           9 months ago
  • 0.36.8                                ...           9 months ago
  • 0.36.8-beta4                                ...           9 months ago
  • 0.36.8-beta3                                ...           9 months ago
  • 0.36.8-beta2                                ...           9 months ago
  • 0.36.8-beta                                ...           9 months ago
  • 0.36.7                                ...           9 months ago
  • 0.36.6                                ...           9 months ago
  • 0.36.5                                ...           9 months ago
  • 0.36.4                                ...           9 months ago
  • 0.36.3                                ...           9 months ago
  • 0.36.2                                ...           9 months ago
  • 0.36.1                                ...           9 months ago
  • 0.36.0                                ...           10 months ago
  • 0.35.0-rc2                                ...           10 months ago
  • 0.35.0-rc1                                ...           10 months ago
  • 0.34.6                                ...           10 months ago
  • 0.35.0-alpha.4                                ...           10 months ago
  • 0.35.0-alpha.3                                ...           10 months ago
  • 0.35.0-alpha.2                                ...           10 months ago
  • 0.35.0-alpha.1                                ...           10 months ago
  • 0.34.5                                ...           10 months ago
  • 0.34.4                                ...           10 months ago
  • 0.34.3                                ...           10 months ago
  • 0.34.2                                ...           10 months ago
  • 0.34.1                                ...           10 months ago
  • 0.34.0                                ...           10 months ago
  • 0.33.17                                ...           10 months ago
  • 0.33.16                                ...           10 months ago
  • 0.33.15                                ...           10 months ago
  • 0.33.14                                ...           10 months ago
  • 0.33.13                                ...           10 months ago
  • 0.33.12                                ...           10 months ago
  • 0.33.11                                ...           10 months ago
  • 0.33.10                                ...           10 months ago
  • 0.33.9                                ...           10 months ago
  • 0.33.8                                ...           10 months ago
  • 0.33.7                                ...           10 months ago
  • 0.33.5                                ...           10 months ago
  • 0.33.4                                ...           10 months ago
  • 0.33.3                                ...           10 months ago
  • 0.33.2                                ...           10 months ago
  • 0.33.1                                ...           10 months ago
  • 0.33.0                                ...           10 months ago
  • 0.32.5                                ...           a year ago
  • 0.32.4                                ...           a year ago
  • 0.32.3                                ...           a year ago
  • 0.32.2                                ...           a year ago
  • 0.32.1                                ...           a year ago
  • 0.32.0                                ...           a year ago
  • 0.31.3                                ...           a year ago
  • 0.31.2                                ...           a year ago
  • 0.31.1                                ...           a year ago
  • 0.31.0                                ...           a year ago
  • 0.30.8                                ...           a year ago
  • 0.30.7                                ...           a year ago
  • 0.30.6                                ...           a year ago
  • 0.30.5                                ...           a year ago
  • 0.30.4                                ...           a year ago
  • 0.30.3                                ...           a year ago
  • 0.30.2                                ...           a year ago
  • 0.30.1                                ...           a year ago
  • 0.30.0                                ...           a year ago
  • 0.29.1                                ...           a year ago
  • 0.29.0                                ...           a year ago
  • 0.28.11                                ...           a year ago
  • 0.28.10                                ...           a year ago
  • 0.28.9                                ...           a year ago
  • 0.28.5                                ...           a year ago
  • 0.28.4                                ...           a year ago
  • 0.28.3                                ...           a year ago
  • 0.28.2                                ...           a year ago
  • 0.28.1                                ...           a year ago
  • 0.28.0                                ...           a year ago
  • 0.27.13                                ...           a year ago
  • 0.27.12                                ...           a year ago
  • 0.27.11                                ...           a year ago
  • 0.27.10                                ...           a year ago
  • 0.27.7                                ...           a year ago
  • 0.27.6                                ...           a year ago
  • 0.27.4                                ...           a year ago
  • 0.27.3                                ...           a year ago
  • 0.27.1                                ...           a year ago
  • 0.27.0                                ...           a year ago
  • 0.26.10                                ...           a year ago
  • 0.26.7                                ...           a year ago
  • 0.26.6                                ...           a year ago
  • 0.26.5                                ...           a year ago
  • 0.26.4                                ...           a year ago
  • 0.26.3                                ...           a year ago
  • 0.26.2                                ...           a year ago
  • 0.26.1                                ...           a year ago
  • 0.26.0                                ...           a year ago
  • 0.25.2                                ...           a year ago
  • 0.25.1                                ...           a year ago
  • 0.25.0                                ...           a year ago
  • 0.22.0                                ...           a year ago
  • 0.21.0                                ...           a year ago
  • 0.20.6                                ...           a year ago
  • 0.20.5                                ...           a year ago
  • 0.20.4                                ...           a year ago
  • 0.20.3                                ...           a year ago
  • 0.20.2                                ...           a year ago
  • 0.20.1                                ...           a year ago
  • 0.20.0                                ...           a year ago
  • 0.19.0                                ...           a year ago
  • 0.18.0                                ...           a year ago
  • 0.17.8                                ...           a year ago
  • 0.17.7                                ...           a year ago
  • 0.17.6                                ...           a year ago
  • 0.17.5                                ...           a year ago
  • 0.17.4                                ...           a year ago
  • 0.17.3                                ...           a year ago
  • 0.17.0                                ...           a year ago
  • 0.16.0                                ...           a year ago
  • 0.15.2 [deprecated]           ...           a year ago
  • 0.15.1 [deprecated]           ...           a year ago
  • 0.15.0 [deprecated]           ...           a year ago
  • 0.14.4                                ...           a year ago
  • 0.14.3                                ...           a year ago
  • 0.14.1                                ...           a year ago
  • 0.14.0                                ...           a year ago
  • 0.13.4                                ...           a year ago
  • 0.13.2                                ...           a year ago
  • 0.13.1                                ...           a year ago
  • 0.13.0                                ...           a year ago
  • 0.12.3                                ...           a year ago
  • 0.12.2                                ...           a year ago
  • 0.12.0                                ...           a year ago
  • 0.11.1                                ...           a year ago
  • 0.11.0                                ...           a year ago
  • 0.10.0                                ...           a year ago
  • 0.9.0                                ...           a year ago
  • 0.8.8                                ...           a year ago
  • 0.8.7                                ...           a year ago
  • 0.8.6                                ...           a year ago
  • 0.8.4                                ...           a year ago
  • 0.8.3                                ...           a year ago
  • 0.8.1                                ...           a year ago
  • 0.8.0                                ...           a year ago
  • 0.7.11                                ...           a year ago
  • 0.7.10                                ...           a year ago
  • 0.7.9                                ...           a year ago
  • 0.7.8                                ...           a year ago
  • 0.7.7                                ...           a year ago
  • 0.7.6                                ...           a year ago
  • 0.7.5                                ...           a year ago
  • 0.7.4                                ...           a year ago
  • 0.7.3                                ...           a year ago
  • 0.7.0                                ...           a year ago
  • 0.6.9                                ...           a year ago
  • 0.6.8                                ...           a year ago
  • 0.6.7                                ...           a year ago
  • 0.6.6                                ...           a year ago
  • 0.6.5                                ...           a year ago
  • 0.6.4                                ...           a year ago
  • 0.6.3                                ...           a year ago
  • 0.6.2                                ...           a year ago
  • 0.6.1                                ...           a year ago
  • 0.6.0                                ...           a year ago
  • 0.5.8                                ...           a year ago
  • 0.5.4                                ...           a year ago
  • 0.5.3                                ...           a year ago
  • 0.5.1                                ...           a year ago
Maintainers (2)
Downloads
Today 0
This Week 1
This Month 281
Last Day 1
Last Week 280
Last Month 13
Dependencies (60)
Dev Dependencies (11)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |