README.md

Semaphore CLI

A command line tool to set up your Semaphore project and get group data.

👥 Contributing   |   🤝 Code of conduct   |   🔎 Issues   |   🗣️ Chat & Support

Setting up a project, although not particularly complex, can be a lengthy process for some people. The Semaphore CLI reduces the set-up time from a few minutes to a few seconds. In addition, it can also be used to obtain on-chain group data.

🛠 Install

Install the @semaphore-protocol/cli package globally:

npm i -g @semaphore-protocol/cli

or run specific commands with npx:

npx @semaphore-protocol/cli create my-app

📜 Usage

Usage: semaphore [options] [command]

A command line tool to set up your Semaphore project and get group data.

Options:
-v, --version Show Semaphore CLI version.
-h, --help Display this help.

Commands:
  create [options] [project-directory]  Create a Semaphore project with a supported template.
  get-groups [options]                  Get the list of groups from a supported network (e.g. goerli or arbitrum).
  get-group [options] [group-id]        Get the data of a group from a supported network (e.g. goerli or arbitrum).
  get-members [options] [group-id]      Get the members of a group from a supported network (e.g. goerli or arbitrum).
  get-proofs [options] [group-id]       Get the proofs of a group from a supported network (e.g. goerli or arbitrum).
  help [command]                        Display help for a specific command.