Note: This is a read-only mirror of the formal Gerrit repository, where active development is ongoing. Issue tracking is handled in Jira

This repo is going to be used to implement FAB-10734 Fabric CLI Redesign. This is NOT the "official" Fabric CLI and there is not yet any commitment that it is going to be.

Hyperledger Fabric CLI

The Hyperledger Fabric CLI is a tool used to interact with Fabric networks.

Installation

1. Clone this repo
2. Install gobin using GO111MODULE=off go get -u github.com/myitcv/gobin
3. Run make
4. Locate the binary in the bin directory
5. Add the binary to your PATH
6. Execute fabric for more information

Getting Started

1. Add a Network with fabric network set
2. Add a Context with fabric context set
3. Use the new context with fabric context use
4. You're all set... Have fun!

Network

A network is a direct reference to a Fabric-SDK-Go configuration. This configuration contains all of the necessary details for interacting with a Fabric network at a global scope.

Context

A context defines the scope for interactions with the network. An example of this would be: As Admin, I want peer peer0.org1.example.com in organization Org1 to join channel mychannel. In this example, the context would include the identity, peer, organization, and channel.

Built-in Commands

Built-in commands can be found in /cmd/fabric/commands. These commands can serve as examples for building future commands like plugin chaincode install ....

Plugins

Users can create and install custom commands to the Fabric CLI. The only requirement is that all external commands must provide a plugin.yaml.

The YAML must specify:

• Name - command name
• Usage - usage syntax
• Description - short description shown for help
• Command - plugin execution

Example plugins can be found in pkg/plugin/testdata/plugins.

Documentation

• Design Document
• User Stories

License

Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/.