@ens-node-metadata/agent 0.2.5 → 0.2.7

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.
Files changed (4) hide show
  1. package/README.md +2 -1
  2. package/SKILL.md +16 -16
  3. package/dist/cli.js +9 -9
  4. package/package.json +2 -2
package/README.md CHANGED
@@ -5,7 +5,8 @@ CLI for registering AI agents on ENS using [ERC-8004](https://best-practices.800
5
5
  ## Usage
6
6
 
7
7
  ```bash
8
- pnpm dlx @ens-node-metadata/agent --help
8
+ pnpm dlx @ens-node-metadata/agent
9
+ # then use: ens-agent --help
9
10
  ```
10
11
 
11
12
  ## Registration Flow
package/SKILL.md CHANGED
@@ -15,22 +15,22 @@ A skill to help manage your agents metadata on ENS along with ERC-8004 managemen
15
15
 
16
16
  ## Command overview
17
17
 
18
- Run `agent --help` or `agent <command> --help` for full usage.
18
+ Run `ens-agent --help` or `ens-agent <command> --help` for full usage.
19
19
 
20
20
  ```sh
21
- agent registration-file template # prints example JSON
22
- agent registration-file validate <file> # validates SCHEMA_8004_V2
23
- agent registration-file publish <file> # upload to IPFS via Pinata
21
+ ens-agent registration-file template # prints example JSON
22
+ ens-agent registration-file validate <file> # validates SCHEMA_8004_V2
23
+ ens-agent registration-file publish <file> # upload to IPFS via Pinata
24
24
  # => Returns <agent-uri>
25
25
 
26
26
  # Register agent with canonical 8004 registries
27
- agent registry identity --chain-name <chain> <agent-uri> --private-key <0x...> [--broadcast]
27
+ ens-agent registry identity --chain-name <chain> <agent-uri> --private-key <0x...> [--broadcast]
28
28
 
29
- agent metadata template # starter ENS text-record payload
30
- agent metadata validate <payload> # validates metadata JSON schema
31
- agent metadata set <AGENT_ENS_NAME> <payload> --private-key <0x...> [--broadcast]
29
+ ens-agent metadata template # starter ENS text-record payload
30
+ ens-agent metadata validate <payload> # validates metadata JSON schema
31
+ ens-agent metadata set <AGENT_ENS_NAME> <payload> --private-key <0x...> [--broadcast]
32
32
 
33
- agent skill [--install] # Installs
33
+ ens-agent skill [--install] # Installs
34
34
  ```
35
35
 
36
36
  ## Workflows
@@ -43,10 +43,10 @@ A registration file is required to register your Agent's identity.
43
43
 
44
44
  ```sh
45
45
  # edit with your details
46
- agent registration-file template > registration.json`
46
+ ens-agent registration-file template > registration.json`
47
47
 
48
48
  # validate
49
- agent registration-file validate registration.json`
49
+ ens-agent registration-file validate registration.json`
50
50
  ```
51
51
 
52
52
  #### Publishing a registration file
@@ -59,7 +59,7 @@ The following variables should be in your environment to use this command.
59
59
 
60
60
  ```sh
61
61
  # Publish to IPFS
62
- agent registration-file publish registration.json`
62
+ ens-agent registration-file publish registration.json`
63
63
  # Returns => ipfs://CID henceforth referred to as <agent-uri>
64
64
  ```
65
65
 
@@ -68,7 +68,7 @@ agent registration-file publish registration.json`
68
68
  We publish to the cannonical registries <https://github.com/erc-8004/erc-8004-contracts>
69
69
 
70
70
  ```sh
71
- agent registry identity --chain-name <chain> <agent-uri> --private-key <0x...> [--broadcast]
71
+ ens-agent registry identity --chain-name <chain> <agent-uri> --private-key <0x...> [--broadcast]
72
72
  # Returns => <agent-id>
73
73
  ```
74
74
 
@@ -80,10 +80,10 @@ A metadata payload descrbes which text records to set.
80
80
 
81
81
  ```sh
82
82
  # Agent metadata expressed as JSON schema
83
- agent metadata template > payload.json
83
+ ens-agent metadata template > payload.json
84
84
 
85
85
  # Validator
86
- agent metadata validate payload.json
86
+ ens-agent metadata validate payload.json
87
87
  ```
88
88
 
89
89
  #### Updating metadata on ENS
@@ -93,7 +93,7 @@ agent metadata validate payload.json
93
93
  * Remember to also update your `<agent-uri>`.
94
94
 
95
95
  ```sh
96
- agent metadata set <AGENT_ENS_NAME> payload.json --private-key 0x<KEY> --broadcast`
96
+ ens-agent metadata set <AGENT_ENS_NAME> payload.json --private-key 0x<KEY> --broadcast`
97
97
  ```
98
98
 
99
99
  ## References
package/dist/cli.js CHANGED
@@ -9,19 +9,19 @@ if (isRootHelp) {
9
9
  CLI for registering AI agents on ENS using ERC-8004 (v2.0).
10
10
 
11
11
  Usage:
12
- agent skill [--install]
12
+ ens-agent skill [--install]
13
13
 
14
- agent registration-file template
15
- agent registration-file validate <file.json>
16
- agent registration-file publish <file.json>
14
+ ens-agent registration-file template
15
+ ens-agent registration-file validate <file.json>
16
+ ens-agent registration-file publish <file.json>
17
17
 
18
- agent registry identity --chain-name <chain> <agent-uri>
18
+ ens-agent registry identity --chain-name <chain> <agent-uri>
19
19
 
20
- agent metadata template
21
- agent metadata validate <payload.json>
22
- agent metadata set <ens-node> <payload.json> --private-key <key> [--broadcast]
20
+ ens-agent metadata template
21
+ ens-agent metadata validate <payload.json>
22
+ ens-agent metadata set <ens-node> <payload.json> --private-key <key> [--broadcast]
23
23
 
24
- Run \`agent <command> --help\` for details on a specific command.
24
+ Run \`ens-agent <command> --help\` for details on a specific command.
25
25
  `);
26
26
  process.exit(0);
27
27
  }
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@ens-node-metadata/agent",
3
- "version": "0.2.5",
3
+ "version": "0.2.7",
4
4
  "description": "CLI for registering AI agents on ENS using ERC-8004",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
7
7
  "types": "./dist/index.d.ts",
8
8
  "bin": {
9
- "agent": "./dist/cli.js"
9
+ "ens-agent": "./dist/cli.js"
10
10
  },
11
11
  "exports": {
12
12
  ".": "./dist/index.js"