{"id":15145089,"url":"https://github.com/arcblock/forge-cli","last_synced_at":"2025-09-29T13:31:36.059Z","repository":{"id":48011113,"uuid":"190330540","full_name":"ArcBlock/forge-cli","owner":"ArcBlock","description":":fire: Awesome Command line tool to mange forge powered blockchain nodes","archived":true,"fork":false,"pushed_at":"2021-08-11T02:04:20.000Z","size":3215,"stargazers_count":10,"open_issues_count":26,"forks_count":0,"subscribers_count":22,"default_branch":"master","last_synced_at":"2024-12-29T23:18:52.653Z","etag":null,"topics":["arcblock","blockchain","cli","forge","javascript","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ArcBlock.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-05T05:20:01.000Z","updated_at":"2024-12-22T05:02:41.000Z","dependencies_parsed_at":"2022-08-12T16:31:15.463Z","dependency_job_id":null,"html_url":"https://github.com/ArcBlock/forge-cli","commit_stats":null,"previous_names":[],"tags_count":110,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcBlock%2Fforge-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcBlock%2Fforge-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcBlock%2Fforge-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArcBlock%2Fforge-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArcBlock","download_url":"https://codeload.github.com/ArcBlock/forge-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234624106,"owners_count":18862287,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arcblock","blockchain","cli","forge","javascript","nodejs"],"created_at":"2024-09-26T11:08:30.906Z","updated_at":"2025-09-29T13:31:26.048Z","avatar_url":"https://github.com/ArcBlock.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![forge-cli](https://www.arcblock.io/.netlify/functions/badge/?text=Forge%20CLI)\n\n\u003e Command line toolbox maintained by [Arcblock](https://www.arcblock.io) that helps developers to work with [Forge SDK](https://docs.arcblock.io/en/docs/instruction/sdk)\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [QuickStart](#quickstart)\n- [Requirements](#requirements)\n- [Install](#install)\n- [Usage](#usage)\n- [FAQ](#faq)\n\n## Introduction\n\n[![](https://img.shields.io/npm/v/@arcblock/forge-cli.svg?label=forge-cli\u0026style=flat-square)](https://www.npmjs.com/package/@arcblock/forge-cli)\n[![docs](https://img.shields.io/badge/powered%20by-arcblock-green.svg?style=flat-square)](https://docs.arcblock.io/en/handbook/)\n[![Build Status](https://img.shields.io/travis/com/arcblock/forge-cli?style=flat-square)](https://travis-ci.com/arcblock/forge-cli)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\n[![Gitter](https://img.shields.io/gitter/room/ArcBlock/community?style=flat-square\u0026color=%234cb696)](https://gitter.im/ArcBlock/community?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n\n`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:\n\n- Manage forge kernel release\n- Manage local forge node, join a remote forge powered network\n- Create wallets and accounts on blockchain\n- Read/subscribe accounts/blocks/transactions/assets on blockchain\n- Send transactions to the blockchain\n- Use forge components such as forge-web\n- Compile and deploy transaction protocol\n- Do stake to node/user/asset\n- Bootstrap dApps with starters from [here](https://github.com/ArcBlock/forge-dapp-starters)\n\n## Requirements\n\n- Linux/Mac Command Line, **windows is not support currently**, [iTerm](http://www.iterm2.com/) is recommended.\n- [Node.js](https://nodejs.org/): please install using [nvm](https://github.com/creationix/nvm), \u003e= v10 \u0026\u0026 \u003c= v12.x\n\n## QuickStart\n\n[![asciicast](https://asciinema.org/a/280694.svg)](https://asciinema.org/a/280694)\n\n## Install\n\n```shell\nnpm install -g @arcblock/forge-cli\n# OR\nyarn global add @arcblock/forge-cli\n```\n\nNow `forge` command is available to all new shell sessions.\n\n## Usage\n\nRun `forge` and get available options and subcommands.\n\n```terminal\n❯ forge\n\n██████╗ ██╗   ██╗     █████╗ ██████╗  ██████╗██████╗ ██╗      ██████╗  ██████╗██╗  ██╗\n██╔══██╗╚██╗ ██╔╝    ██╔══██╗██╔══██╗██╔════╝██╔══██╗██║     ██╔═══██╗██╔════╝██║ ██╔╝\n██████╔╝ ╚████╔╝     ███████║██████╔╝██║     ██████╔╝██║     ██║   ██║██║     █████╔╝ \n██╔══██╗  ╚██╔╝      ██╔══██║██╔══██╗██║     ██╔══██╗██║     ██║   ██║██║     ██╔═██╗ \n██████╔╝   ██║       ██║  ██║██║  ██║╚██████╗██████╔╝███████╗╚██████╔╝╚██████╗██║  ██╗\n╚═════╝    ╚═╝       ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝╚═════╝ ╚══════╝ ╚═════╝  ╚═════╝╚═╝  ╚═╝\n                                                                                      \nUsage: forge [options] [command]\n\nOptions:\n  -V, --version                    output the version number\n  -v, --verbose                    Output runtime info when execute subcommand, useful for debug\n  -c, --chain-name \u003cchainName\u003e     Execute command use specific chain\n  -i, --config-path \u003cpath\u003e         Forge config used when starting forge node and initializing gRPC clients\n  -r, --npm-registry \u003cregistry\u003e    Specify a custom npm registry\n  -y, --yes                        Assume that the answer to any confirmation question is yes\n  -d, --defaults                   Run command using default values for all questions\n  -m, --mirror \u003curl\u003e               Mirror host used to download forge release\n  -g, --socket-grpc \u003cendpoint\u003e     Socket gRPC endpoint to connect, with this you can use forge-cli with a remote node\n  -h, --help                       output usage information\n\nCommands:\n  account \u003caddress\u003e                Get an account info by address\n  asset \u003caddress\u003e                  Get asset info by address\n  block [options] [height]         Get the block info from the running node\n  blocklet:init [options]          Init a blocklet project\n  blocklet:use [options]           Download and install a blocklet\n  chain:config [options] [action]  Read/write chain/node config\n  chain:create [chainName]         Create a new chain instance\n  chain:ls                         List all chains\n  chain:remove \u003cchainName\u003e         Remove chain state and config\n  chain:reset \u003cchainName\u003e          Reset chain state, but keeps the config\n  chain:validator [options]        Update(add, remove, change) or list validators\n  config [options] [key] [value]   Config forge cli configs\n  declare:node [options]           Declare the current node to be a validator candidate\n  deploy:prepare [options]         Prepare node for deploying a multi-node chain\n  download [options] [version]     Download a forge release without activate it\n  help [subcommand]                Show help of a sub command\n  install [options] [version]      Download and setup forge release on this machine\n  join \u003cendpoint\u003e                  Join a network by providing a valid forge web graphql endpoint\n  logs [type]                      Show logs for various forge components\n  ls                               List forge releases installed locally\n  ls:remote                        List remote forge releases available for install\n  ps                               List running forge component processes\n  remote [shellName]               Connects to the running system via a remote shell\n  simulator [action]               Start/stop simulator and generate random traffic\n  start [options] [\u003cchainName\u003e]    Start the forge and forge web deamon\n  status [type]                    List info of the running chain/node\n  stop [options] [\u003cchainName\u003e]     Stop the forge daemon and all related services\n  tx [hash]                        Get a tx detail and display\n  tx:ls                            List latest transactions\n  upgrade [\u003cchainName\u003e]            Upgrade chain node to new version without reset\n  use [version]                    Activate an already downloaded forge release\n  version [\u003cchainName\u003e]            Output version for all forge components\n  wallet:create                    Create a local wallet and dump its public/private key\n  web [action]                     Open the web interface of running forge chain/node\n\nExamples:\n\n  Please install a forge-release before running any other commands\n  \u003e forge install latest\n  \u003e forge install --mirror https://releases.arcblockio.cn\n\n  Curious about how to use a subcommand?\n  \u003e forge help install\n  \n\n```\n\n## FAQ\n\nCheckout [FAQ.md](./docs/FAQ.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farcblock%2Fforge-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farcblock%2Fforge-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farcblock%2Fforge-cli/lists"}