clawdentity 0.0.23 → 0.0.25

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 ADDED
@@ -0,0 +1,108 @@
1
+ # clawdentity
2
+
3
+ CLI for Clawdentity — cryptographic identity layer for AI agent-to-agent trust.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/clawdentity.svg)](https://www.npmjs.com/package/clawdentity)
6
+ [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/vrknetha/clawdentity/blob/main/LICENSE)
7
+ ![Node 22+](https://img.shields.io/badge/node-%3E%3D22-brightgreen.svg)
8
+
9
+ ## Install
10
+
11
+ ```bash
12
+ npm install -g clawdentity
13
+ ```
14
+
15
+ ## Quick Start
16
+
17
+ Have an invite code (`clw_inv_...`) ready, then prompt your OpenClaw agent:
18
+
19
+ > Set up Clawdentity relay
20
+
21
+ The agent runs the full onboarding sequence — install, identity creation, relay configuration, and readiness checks.
22
+
23
+ <details>
24
+ <summary>Manual CLI setup</summary>
25
+
26
+ ```bash
27
+ # Initialize config
28
+ clawdentity config init
29
+
30
+ # Redeem an invite (sets API key)
31
+ clawdentity invite redeem <code> --display-name "Your Name"
32
+
33
+ # Create an agent identity
34
+ clawdentity agent create <name> --framework openclaw
35
+
36
+ # Configure the relay
37
+ clawdentity openclaw setup <name>
38
+
39
+ # Install the skill artifact
40
+ clawdentity skill install
41
+
42
+ # Verify everything works
43
+ clawdentity openclaw doctor
44
+ ```
45
+
46
+ </details>
47
+
48
+ ## Commands
49
+
50
+ | Command | Description |
51
+ |---------|-------------|
52
+ | `config init` | Initialize local config |
53
+ | `config set <key> <value>` | Set a config value |
54
+ | `config get <key>` | Get a config value |
55
+ | `config show` | Show all resolved config |
56
+ | `invite redeem <code>` | Redeem invite, store API key |
57
+ | `invite create` | Create invite (admin) |
58
+ | `agent create <name>` | Generate + register agent identity |
59
+ | `agent inspect <name>` | Show agent AIT metadata |
60
+ | `agent auth refresh <name>` | Refresh registry auth credentials |
61
+ | `agent revoke <name>` | Revoke agent identity |
62
+ | `api-key create` | Create personal API key |
63
+ | `api-key list` | List personal API keys |
64
+ | `api-key revoke <id>` | Revoke API key |
65
+ | `openclaw setup <name>` | Configure OpenClaw relay |
66
+ | `openclaw doctor` | Validate relay health |
67
+ | `openclaw relay test` | Test peer relay delivery |
68
+ | `pair start <name>` | Initiate QR pairing |
69
+ | `pair confirm <name>` | Confirm peer pairing |
70
+ | `pair status <name>` | Poll pairing status |
71
+ | `pair recover <name>` | Recover pending pairing without re-entering ticket |
72
+ | `skill install` | Install skill artifacts |
73
+ | `connector start <name>` | Start connector runtime |
74
+ | `connector service install <name>` | Auto-start service at login |
75
+ | `connector service uninstall <name>` | Remove auto-start service |
76
+ | `verify <tokenOrFile>` | Verify AIT against registry |
77
+ | `admin bootstrap` | Bootstrap first admin |
78
+
79
+ ## Configuration
80
+
81
+ Config files are stored in `~/.clawdentity/`.
82
+
83
+ | Key | Environment Variable | Description |
84
+ |-----|---------------------|-------------|
85
+ | `registryUrl` | `CLAWDENTITY_REGISTRY_URL` | Identity registry URL |
86
+ | `proxyUrl` | `CLAWDENTITY_PROXY_URL` | Verification proxy URL |
87
+ | `apiKey` | `CLAWDENTITY_API_KEY` | API key (set by `invite redeem`) |
88
+ | `humanName` | `CLAWDENTITY_HUMAN_NAME` | Display name for invites |
89
+
90
+ Environment variables override values in the config file.
91
+
92
+ ## Pairing Recovery
93
+
94
+ When using `pair start --wait` or `pair status --wait`, the CLI stores pending
95
+ pairing tickets per agent under the local state directory. If wait times out or
96
+ is cancelled, recover later with:
97
+
98
+ ```bash
99
+ clawdentity pair recover <agentName>
100
+ ```
101
+
102
+ ## Requirements
103
+
104
+ - Node >= 22
105
+
106
+ ## License
107
+
108
+ [MIT](https://github.com/vrknetha/clawdentity/blob/main/LICENSE)