# passport-scope-cli

> Passport management tool

Latest version **1.1.9** (published 2024-08-30) · 0 weekly downloads

## Install

```sh
npm install passport-scope-cli
pnpm add passport-scope-cli
yarn add passport-scope-cli
bun add passport-scope-cli
```

Provides the command `passport-scope`.

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.9 |
| Published | 2024-08-30 |
| First published | 2023-10-24 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 14 |
| Unpacked size | 23.7 KB |
| Known vulnerabilities | 0 (+13 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | kwk236 |

## Links

- npm: https://www.npmjs.com/package/passport-scope-cli
- npm.io page: https://npm.io/package/passport-scope-cli

## Dependencies (14)

- [siwe](https://npm.io/package/siwe.md) ^2.1.4
- [viem](https://npm.io/package/viem.md) 2.9.4
- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [execa](https://npm.io/package/execa.md) ^7.1.1
- [ethers](https://npm.io/package/ethers.md) ^6.8.0
- [undici](https://npm.io/package/undici.md) ^5.28.3
- [prompts](https://npm.io/package/prompts.md) ^2.4.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^11.1.1
- [commander](https://npm.io/package/commander.md) ^11.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.2
- [@noble/hashes](https://npm.io/package/@noble/hashes.md) ^1.3.2
- [@0xpass/passport](https://npm.io/package/@0xpass/passport.md) 2.1.7
- [@stablelib/random](https://npm.io/package/@stablelib/random.md) ^1.0.2
- [@0xpass/key-signer](https://npm.io/package/@0xpass/key-signer.md) 2.0.1

## Recent versions

- 1.1.9 (latest) — 2024-08-30
- 1.1.8 — 2024-07-11
- 1.1.7 — 2024-06-21
- 1.1.6 — 2024-06-13
- 1.1.5 — 2024-06-04
- 1.1.4 — 2024-06-03
- 1.1.3 — 2024-05-26
- 1.1.2 — 2024-05-20
- 1.1.1 — 2024-05-10
- 1.1.0 — 2024-05-09
- 1.0.8 — 2024-05-07
- 1.0.7 — 2024-05-01
- 1.0.6 — 2024-04-29
- 1.0.5 — 2024-04-28
- 1.0.4 — 2024-04-28
- … 21 more at https://npm.io/package/passport-scope-cli/versions

## README

# Passport Scope CLI Tool

The Passport Scope CLI tool is a command-line interface for managing scopes within the Passport Protocol. It allows you to create new scopes, generate key pairs, and interact with the Passport Protocol nodes.

## Installation

Before using the CLI, ensure you have Node.js and `pnpm` installed. Install `pnpm` globally using `npm`:

```bash
npm install -g pnpm
```

Then, install the CLI tool globally using npm or `pnpm`:

```bash
npm install -g passport-scope-cli
```

```bash
pnpm install -g passport-scope-cli
```

## Usage

To create and manage scopes, the CLI requires a public/private key pair.

The CLI provides the following commands:

### Generate Keys

To generate a public/private key pair, use the `generate-keys` command with the `--name` option to specify the name of the key pair.

```bash
passport-scope generate-keys --name <key-pair-name>
```

For example, to generate a key pair named passport, which generates a passport_priv.pem and passport_pub.pem file:

```bash
passport-scope generate-keys --name passport
```

### Create a New Scope

To create a new scope, use the `create` command with the required `--config-path` option to specify the path of the scope configuration content. Optionally, you can provide the `--private-key` path and enable verbose logging with `-v` or `--verbose`.

```bash
passport-scope create --config-path <path-to-config> [--private-key <path-to-private-key>] [-v]
```

For example, to create a scope with a specific configuration and private key, if you do not pass a private key path, the CLI will prompt you to generate a keypair.

```bash
passport-scope create --config-path ./test.json --private-key ./passport_priv.pem --verbose true
```

---
_Source: https://npm.io/package/passport-scope-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._