{"id":19901894,"url":"https://github.com/hyperledger/firefly-cli","last_synced_at":"2025-04-05T08:06:10.703Z","repository":{"id":38211581,"uuid":"366835646","full_name":"hyperledger/firefly-cli","owner":"hyperledger","description":"FireFly Command Line Interface (CLI)","archived":false,"fork":false,"pushed_at":"2025-03-25T09:39:26.000Z","size":5473,"stargazers_count":62,"open_issues_count":42,"forks_count":59,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-03-29T07:08:11.892Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperledger.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-12T19:46:07.000Z","updated_at":"2025-03-25T09:34:13.000Z","dependencies_parsed_at":"2023-02-18T11:17:49.195Z","dependency_job_id":"610bb23b-e921-4761-bf40-053ba53e0d8a","html_url":"https://github.com/hyperledger/firefly-cli","commit_stats":null,"previous_names":["hyperledger-labs/firefly-cli"],"tags_count":82,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger%2Ffirefly-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperledger","download_url":"https://codeload.github.com/hyperledger/firefly-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305933,"owners_count":20917208,"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":[],"created_at":"2024-11-12T20:16:32.337Z","updated_at":"2025-04-05T08:06:10.683Z","avatar_url":"https://github.com/hyperledger.png","language":"Go","readme":"# FireFly CLI\n\n![build](https://github.com/hyperledger/firefly-cli/actions/workflows/build.yml/badge.svg?branch=main)\n\nThe FireFly CLI can be used to create local [FireFly](https://github.com/hyperledger/firefly) stacks\nfor offline development of blockchain apps. This allows developers to rapidly iterate on their idea without\nneeding to set up a bunch of infrastructure before they can write the first line of code.\n\n![FireFly CLI Screenshot](docs/firefly_screenshot.png)\n\n## Prerequisites\n\nIn order to run the FireFly CLI, you will need a few things installed on your dev machine:\n\n- [Docker](https://www.docker.com/)\n- [Docker Compose](https://docs.docker.com/compose/)\n- openssl\n\n## Install the CLI\n\nThe easiest way to get up and running with the FireFly CLI is to download a pre-compiled binary of the latest release.\n\n### Download the package for your OS\nGo to the [latest release page](https://github.com/hyperledger/firefly-cli/releases/latest) and download the package for your OS and CPU architecture.\n\n### Extract the binary and move it to `/usr/local/bin`\n\nAssuming you downloaded the package from GitHub into you `Downloads` directory, run the following command:\n\n```\nsudo tar -zxf ~/Downloads/firefly-cli_*.tar.gz -C /usr/local/bin ff\n```\n\nIf you downloaded the package from GitHub into a different directory, you will need to change the `tar` command above to wherever the `firefly-cli_*.tar.gz ` file is located.\n\n### macOSUsers\n \u003e **NOTE**: On recent versions of macOS, default security settings will prevent the FireFly CLI binary from running, because it was downloaded from the internet. You will need to [allow the FireFly CLI in System Preferences](docs/mac_help.md), before it will run.\n\n### Windows Users\n \u003e **NOTE**: For Windows users, we recommend that you use [Windows Subsystem for Linux 2 (WSL2)](https://docs.microsoft.com/en-us/windows/wsl/). Binaries provided for Linux will work in this environment.\n\n### Linux Users\n\u003e **NOTE**: For Linux users, it is recommended that you add your user to the `docker` group so that you do not have to run `ff` or `docker` as `root` or with `sudo`. For more information about Docker permissions on Linux, please see [Docker's documentation on the topic](https://docs.docker.com/engine/install/linux-postinstall/).\n\n### Install via Go\n\nIf you have a local Go development environment, and you have included `${GOPATH}/bin` in your path, you can install with:\n\n```sh\ngo install github.com/hyperledger/firefly-cli/ff@latest\n```\n\n## Create a new stack\n\n```\n$ ff init \u003cstack_name\u003e\n```\n\n## Start a stack\n\n```\n$ ff start \u003cstack_name\u003e\n```\n\n## View logs\n\n```\n$ ff logs \u003cstack_name\u003e\n```\n\n\u003e **NOTE**: You can use the `-f` flag on the `logs` command to follow the log output from all nodes in the stack\n\n## Stop a stack\n\n```\n$ ff stop \u003cstack_name\u003e\n```\n\n## Clear all data from a stack\n\nThis command clears all data in a stack, but leaves the stack itself. This is useful for testing when you want to start with a clean slate but don't want to actually recreate the resources in the stack itself. Note: this will also stop the stack if it is running.\n\n```\n$ ff reset \u003cstack_name\u003e\n```\n\n## Completely delete a stack\n\nThis command will completely delete a stack, including all of its data and configuration.\n\n```\n$ ff remove \u003cstack_name\u003e\n```\n\n## Get stack info\n\nThis command will print out information about a particular stack, including whether it is running or not.\n\n```\n$ ff info \u003cstack_name\u003e\n```\n\n## List all stacks\n\nThis command will list all stacks that have been created on your machine.\n\n```\n$ ff ls\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger%2Ffirefly-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperledger%2Ffirefly-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger%2Ffirefly-cli/lists"}