Примечание: отслеживание проблем осуществляется в Jira (https://jira.hyperledger.org/secure/Dashboard.jspa). Если вы обнаружите какие-либо проблемы или захотите добавить новые функции, пожалуйста, работайте с Jira.

Этот репозиторий будет использоваться для реализации FAB-10734 Fabric CLI Redesign (https://jira.hyperledger.org/browse/FAB-10734). Это НЕ «официальный» Fabric CLI, и пока нет никаких обязательств, что он им станет.

Hyperledger Fabric CLI

Hyperledger Fabric CLI — это инструмент, используемый для взаимодействия с сетями Fabric (https://hyperledger-fabric.readthedocs.io/en/latest/).

Установка

1. Клонируйте этот репозиторий.
2. Запустите make.
3. Найдите двоичный файл в каталоге bin.
4. Добавьте двоичный файл к вашему PATH.
5. Выполните fabric для получения дополнительной информации.

Начало работы

1. Добавьте сеть с помощью команды fabric network set.
2. Добавьте контекст с помощью команды fabric context set.
3. Используйте новый контекст с командой fabric context use.
4. Всё готово... Наслаждайтесь!

Сеть

Сеть — это прямая ссылка на конфигурацию Fabric-SDK-Go (https://github.com/hyperledger/fabric-sdk-go/blob/main/pkg/core/config/testdata/config_test.yaml). Эта конфигурация содержит все необходимые детали для взаимодействия с сетью Fabric в глобальном масштабе.

Контекст

Контекст определяет область взаимодействия с сетью. Примером этого может быть: как администратор я хочу, чтобы узел peer0.org1.example.com в организации Org1 присоединился к каналу mychannel. В этом примере контекст будет включать личность, узел, организацию и канал.

Встроенные команды

Встроенные команды можно найти в /cmd/fabric/commands. Эти команды могут служить примерами для создания будущих команд, таких как plugin chaincode install....

Плагины

Пользователи могут создавать и устанавливать собственные команды в Fabric CLI. Единственное требование заключается в том, что все внешние команды должны предоставлять файл plugin.yaml.

YAML должен указывать:

• Имя — имя команды.
• Использование — синтаксис использования.
• Описание — краткое описание, отображаемое для справки.
• Команда — выполнение плагина.

Примеры плагинов можно найти в pkg/plugin/testdata/plugins.

Например, если вы хотите интегрировать cryptogen в fabric cmd:

1. Подготовьте файл plugin.yaml:

    name: cryptogen
    usage: cryptogen [<flags>] <command> [<args> ...]
    description: Utility for generating Hyperledger Fabric key material
    command: cryptogen
2. Выполните команду:

   #PATH — это местоположение plugin.yaml.
   $fabric plugin install $PATH
3. Чтобы использовать команду:

   $fabric cryptogen ...

Вы можете интегрировать некоторые плагины Go или внешнюю команду в fabric cmd.

Документация

• Дизайн-документ.
• Пользовательские истории.

Внесение вклада

1. Создайте форк этого репозитория на GitHub.
2. Клонируйте разветвлённый репозиторий в свою локальную среду (git clone https://github.com/you_username/fabric-cli.git && cd fabric-cli).
3. Создайте свою функциональную ветку (git checkout -b feature-branch).
4. Установите gobin с помощью GO111MODULE=off go get -u github.com/myitcv/gobin.
5. Внесите изменения и используйте make test, чтобы завершить тест.
6. Если тест пройден, добавьте их (git add .).
7. Используйте make lint, чтобы проверить свой код.
8. Если всё верно, зафиксируйте свои изменения (git commit -s).
9. Отправьте на GitHub (git push origin feature-branch).
10. Создайте новый запрос на вытягивание.

Лицензия

Исходные файлы проекта Hyperledger предоставляются по лицензии Apache, версия 2.0 (Apache-2.0), расположенной в файле LICENSE. Файлы документации проекта Hyperledger доступны по лицензии Creative Commons Attribution 4.0 International License (CC-BY-4.0), доступной по адресу http://creativecommons.org/licenses/by/4.0/.