@zoralabs/cli 0.2.4 → 0.3.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 +76 -0
- package/dist/index.js +834 -221
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Zora CLI
|
|
2
|
+
|
|
3
|
+
> **Beta** — This package is in pre-release. Commands, flags, and output formats may change between versions without notice.
|
|
4
|
+
|
|
5
|
+
A command-line tool for interacting with the [Zora](https://zora.co) protocol. Explore coins, check prices, manage wallets, and trade — all from the terminal.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
Requires **Node.js 24+**.
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install -g @zoralabs/cli
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Quick start
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Browse trending coins
|
|
19
|
+
zora explore
|
|
20
|
+
|
|
21
|
+
# Look up a specific coin
|
|
22
|
+
zora get <address-or-name>
|
|
23
|
+
|
|
24
|
+
# Check price history
|
|
25
|
+
zora price-history <address-or-name>
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Commands
|
|
29
|
+
|
|
30
|
+
All commands support `--json` for machine-readable output. Commands with live data (`explore`, `balance`, `profile`) also support `--live` (interactive, default) and `--static` (snapshot). Use `--refresh <seconds>` to set the auto-refresh interval in `--live` mode.
|
|
31
|
+
|
|
32
|
+
| Command | Description | Wallet required |
|
|
33
|
+
| --------------- | --------------------------------------------------------- | --------------- |
|
|
34
|
+
| `explore` | Browse top, new, and highest volume coins | No |
|
|
35
|
+
| `get` | Look up a coin by address or name | No |
|
|
36
|
+
| `price-history` | Display price history for a coin | No |
|
|
37
|
+
| `auth` | Configure or check API key status | No |
|
|
38
|
+
| `profile` | View creator or user profiles | No |
|
|
39
|
+
| `setup` | Set up a wallet (generate or import private key) | — |
|
|
40
|
+
| `buy` | Buy a coin | Yes |
|
|
41
|
+
| `sell` | Sell a coin | Yes |
|
|
42
|
+
| `balance` | Show wallet balances (ETH, USDC, ZORA) and coin positions | Yes |
|
|
43
|
+
| `wallet` | Show wallet address, storage location, or export key | Yes |
|
|
44
|
+
| `send` | Send tokens to another address | Yes |
|
|
45
|
+
|
|
46
|
+
Run `zora --help` or `zora <command> --help` for detailed usage.
|
|
47
|
+
|
|
48
|
+
## Wallet setup
|
|
49
|
+
|
|
50
|
+
Commands that sign transactions require a wallet. Set one up with:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
zora setup # interactive — create or import a key
|
|
54
|
+
zora setup --create # generate a new key non-interactively
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The private key is stored locally at `~/.config/zora/wallet.json` with restricted permissions. Alternatively, set the `ZORA_PRIVATE_KEY` environment variable.
|
|
58
|
+
|
|
59
|
+
## API key (optional)
|
|
60
|
+
|
|
61
|
+
Read-only commands work without an API key but may be rate-limited. To get a key, create an account at [zora.co](https://zora.co) and generate one at [zora.co/settings/developer](https://zora.co/settings/developer), then:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
zora auth configure # save the key
|
|
65
|
+
zora auth status # check current config
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
The `ZORA_API_KEY` environment variable takes precedence over the saved config.
|
|
69
|
+
|
|
70
|
+
## Documentation
|
|
71
|
+
|
|
72
|
+
Full documentation is available at [docs.zora.co](https://docs.zora.co/).
|
|
73
|
+
|
|
74
|
+
## Feedback
|
|
75
|
+
|
|
76
|
+
Reach out at [x.com/zoradevs](https://x.com/zoradevs) or [warpcast/~/channel/zora-devs](https://warpcast.com/~/channel/zora-devs).
|