@zoralabs/cli 0.3.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -16
- package/dist/index.js +1239 -502
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ A command-line tool for interacting with the [Zora](https://zora.co) protocol. E
|
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
9
|
-
Requires **Node.js
|
|
9
|
+
Requires **Node.js 20+**.
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
npm install -g @zoralabs/cli
|
|
@@ -15,6 +15,9 @@ npm install -g @zoralabs/cli
|
|
|
15
15
|
## Quick start
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
+
# Guided first-time setup — wallet, API key, and deposit instructions
|
|
19
|
+
zora setup
|
|
20
|
+
|
|
18
21
|
# Browse trending coins
|
|
19
22
|
zora explore
|
|
20
23
|
|
|
@@ -31,41 +34,39 @@ All commands support `--json` for machine-readable output. Commands with live da
|
|
|
31
34
|
|
|
32
35
|
| Command | Description | Wallet required |
|
|
33
36
|
| --------------- | --------------------------------------------------------- | --------------- |
|
|
37
|
+
| `setup` | Guided first-time setup (wallet + API key + deposit info) | — |
|
|
34
38
|
| `explore` | Browse top, new, and highest volume coins | No |
|
|
35
39
|
| `get` | Look up a coin by address or name | No |
|
|
36
40
|
| `price-history` | Display price history for a coin | No |
|
|
37
41
|
| `auth` | Configure or check API key status | No |
|
|
38
42
|
| `profile` | View creator or user profiles | No |
|
|
39
|
-
| `setup` | Set up a wallet (generate or import private key) | — |
|
|
40
43
|
| `buy` | Buy a coin | Yes |
|
|
41
44
|
| `sell` | Sell a coin | Yes |
|
|
42
45
|
| `balance` | Show wallet balances (ETH, USDC, ZORA) and coin positions | Yes |
|
|
43
|
-
| `wallet` | Show wallet address,
|
|
46
|
+
| `wallet` | Show wallet address, export key, or configure wallet | Yes |
|
|
44
47
|
| `send` | Send tokens to another address | Yes |
|
|
45
48
|
|
|
46
49
|
Run `zora --help` or `zora <command> --help` for detailed usage.
|
|
47
50
|
|
|
48
|
-
##
|
|
51
|
+
## Setup
|
|
49
52
|
|
|
50
|
-
|
|
53
|
+
`zora setup` walks through three steps: wallet configuration, API key (optional), and deposit instructions. It is re-runnable — existing configuration is detected and can be kept or overwritten.
|
|
51
54
|
|
|
52
55
|
```bash
|
|
53
|
-
zora setup # interactive
|
|
54
|
-
zora setup --create # generate a new key
|
|
56
|
+
zora setup # interactive 3-step flow
|
|
57
|
+
zora setup --create # skip wallet prompt, generate a new key
|
|
58
|
+
zora setup --yes # non-interactive, accept all defaults
|
|
59
|
+
zora setup --force # overwrite existing wallet and API key
|
|
55
60
|
```
|
|
56
61
|
|
|
57
|
-
The private key is stored locally at `~/.config/zora/wallet.json` with restricted permissions.
|
|
58
|
-
|
|
59
|
-
## API key (optional)
|
|
62
|
+
The private key is stored locally at `~/.config/zora/wallet.json` with restricted permissions. `ZORA_PRIVATE_KEY` and `ZORA_API_KEY` environment variables take precedence over saved config files.
|
|
60
63
|
|
|
61
|
-
|
|
64
|
+
### Advanced
|
|
62
65
|
|
|
63
|
-
|
|
64
|
-
zora auth configure # save the key
|
|
65
|
-
zora auth status # check current config
|
|
66
|
-
```
|
|
66
|
+
To configure wallet or API key individually (without running the full setup flow). All commands work without an API key but may be rate-limited:
|
|
67
67
|
|
|
68
|
-
|
|
68
|
+
- `zora wallet configure` — create or import a wallet (`--create`, `--force`)
|
|
69
|
+
- `zora auth configure` — save an API key; `zora auth status` — check current config
|
|
69
70
|
|
|
70
71
|
## Documentation
|
|
71
72
|
|