@everyprotocol/every-cli 0.1.0 → 0.1.1
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/LICENSE +7 -0
- package/README.md +99 -0
- package/package.json +1 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Copyright 2025 "Every Protocol" Project Steward.
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
4
|
+
|
|
5
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
6
|
+
|
|
7
|
+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1 +1,100 @@
|
|
|
1
|
+
# Every CLI
|
|
1
2
|
|
|
3
|
+
A command-line interface for interacting with the Every Protocol.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
bun add -g @everyprotocol/every-cli
|
|
9
|
+
npm install -g @everyprotocol/every-cli
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Configuration
|
|
13
|
+
|
|
14
|
+
> **Note:** You normally don’t need to configure anything manually.
|
|
15
|
+
> A default configuration is bundled with support for all chains officially supported by the protocol.
|
|
16
|
+
|
|
17
|
+
The CLI looks for configuration in the following locations (in order of precedence):
|
|
18
|
+
1. `.every.toml` in the current directory
|
|
19
|
+
2. `.every.toml` in your home directory
|
|
20
|
+
3. The default configuration bundled with the package
|
|
21
|
+
|
|
22
|
+
Example configuration:
|
|
23
|
+
|
|
24
|
+
```toml
|
|
25
|
+
[universes.local]
|
|
26
|
+
rpc_url = "http://localhost:8545"
|
|
27
|
+
contracts.KindRegistry = "0x5FbDB2315678afecb367f032d93F642f64180aa3"
|
|
28
|
+
contracts.SetRegistry = "0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512"
|
|
29
|
+
contracts.ElementRegistry = "0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0"
|
|
30
|
+
contracts.OmniRegistry = "0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9"
|
|
31
|
+
contracts.ObjectMinter = "0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9"
|
|
32
|
+
|
|
33
|
+
[universes.testnet]
|
|
34
|
+
rpc_url = "https://testnet-rpc.example.com"
|
|
35
|
+
contracts.KindRegistry = "0x..."
|
|
36
|
+
# Add other contract addresses as needed
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Usage
|
|
40
|
+
|
|
41
|
+
The CLI provides commands for interacting with different aspects of the Every Protocol:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
every --help
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Main Commands
|
|
48
|
+
|
|
49
|
+
- `every kind` - Manage kinds
|
|
50
|
+
- `every set` - Manage sets
|
|
51
|
+
- `every relation` - Manage relations
|
|
52
|
+
- `every unique` - Manage uniques
|
|
53
|
+
- `every value` - Manage values
|
|
54
|
+
- `every object` - Create and interact with objects
|
|
55
|
+
- `every mintpolicy` - Manage mint policies
|
|
56
|
+
|
|
57
|
+
### Examples
|
|
58
|
+
|
|
59
|
+
#### Minting an Object
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
every object mint 17.1 0xYourAddress
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
#### Relating objects
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
every object relate 17.1 42 18.2
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
#### Viewing Object Information
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
every object owner 17.1
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Signing Transactions
|
|
78
|
+
|
|
79
|
+
Most write operations require signing with a wallet or private key. You can provide your private key or use a keystore:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
-k, --private-key <key> Private key to sign the transaction
|
|
83
|
+
-a, --account <account> Name of the keystore to sign the transaction
|
|
84
|
+
-p, --password [password] Password to decrypt the keystore
|
|
85
|
+
-f, --password-file <file> File containing the password to decrypt the keystore
|
|
86
|
+
--foundry Use keystore from Foundry directory (~/.foundry/keystores)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
#### Using a private key
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
every object mint 17.1 0xRecipient --private-key 0xYourPrivateKey
|
|
93
|
+
```
|
|
94
|
+
#### Using a keystore
|
|
95
|
+
```bash
|
|
96
|
+
every object mint 17.1 0xRecipient --account myaccount
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## License
|
|
100
|
+
[MIT](LICENSE)
|