mirror of https://github.com/semaphore-protocol/semaphore.git synced 2026-04-28 03:00:41 -04:00

Files

cedoor e875fa4aa3 chore: update discord links

Former-commit-id: bd06422ef5

2023-02-22 13:22:46 +01:00

src

refactor(cli): change some inquirer messages

2023-02-15 12:29:32 -05:00

build.tsconfig.json

build(cli): add subgraph package ts path

2022-12-15 14:03:57 +01:00

LICENSE

chore(cli): add cli package and basic setup

2022-12-08 20:45:45 +01:00

package.json

chore(semaphore): v3.1.0

2023-02-15 20:47:23 +01:00

README.md

chore: update discord links

2023-02-22 13:22:46 +01:00

rollup.config.ts

chore(cli): add cli package and basic setup

2022-12-08 20:45:45 +01:00

tsconfig.json

feat(cli): create get-group command

2022-12-09 18:34:14 +01:00

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 <project-directory> Create a Semaphore project with a supported template.
get-groups [options] Get the list of groups from a supported network (Goerli or Arbitrum).
get-group [options] <group-id> Get the data of a group from a supported network (Goerli or Arbitrum).
help [command] Display help for a specific command.