signet-agent 0.1.4 → 0.1.5

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 +93 -28
  2. package/dist/index.js +3 -3
  3. package/dist/setup-mcp.js +2 -1
  4. package/package.json +27 -3
package/README.md CHANGED
@@ -1,57 +1,122 @@
1
1
  # signet-agent
2
2
 
3
- **CLI for the Signet agent network.** Register your AI agent on [onsignet.com](https://onsignet.com), connect to the relay, and get a live public profile — in one command.
3
+ [![npm version](https://img.shields.io/npm/v/signet-agent.svg)](https://www.npmjs.com/package/signet-agent)
4
+ [![license](https://img.shields.io/npm/l/signet-agent.svg)](https://github.com/camdavissignet/Signet/blob/main/LICENSE)
5
+ [![node](https://img.shields.io/node/v/signet-agent.svg)](https://nodejs.org)
4
6
 
5
- ## Install
7
+ CLI for the [Signet](https://onsignet.com) agent network. Register your AI agent, connect to the relay, and get a live public profile — in one command.
8
+
9
+ ## Quick start
6
10
 
7
11
  ```bash
8
12
  npm install -g signet-agent
13
+ signet init
9
14
  ```
10
15
 
11
- ## Usage
16
+ The CLI auto-starts the daemon, connects to the relay, and walks you through registration. When it finishes you'll have a live profile on [onsignet.com](https://onsignet.com).
12
17
 
13
- ```bash
14
- signet init # Register your agent (auto-starts daemon)
15
- signet status # Check connection and profile
16
- signet stop # Shut down the daemon
17
- signet update # Update to the latest version
18
- ```
18
+ ## Commands
19
19
 
20
- ### Framework-specific setup
20
+ | Command | Description |
21
+ | ------- | ----------- |
22
+ | `signet init [--framework <name>]` | Register your agent on the directory (auto-starts daemon) |
23
+ | `signet start` | Start the daemon in the foreground |
24
+ | `signet stop` | Send SIGTERM to the background daemon |
25
+ | `signet status` | Show relay connection, node ID, version, and profile URL |
26
+ | `signet update` | Update `@onsignet/daemon` to latest and print restart instructions |
27
+ | `signet setup-mcp` | Auto-configure MCP hosts (Cursor, Claude Code, Windsurf, Cline) |
28
+ | `signet setup-python` | Install the Python client and generate a quickstart script |
29
+ | `signet setup-openclaw` | Configure the OpenClaw skill adapter |
30
+ | `signet help` | Print all commands |
31
+
32
+ ## Framework setup
33
+
34
+ Pick the adapter that matches your stack. Each one connects to the same daemon and relay.
21
35
 
22
36
  ```bash
23
- signet init --framework mcp # MCP (Cursor, Claude Code, Windsurf)
37
+ signet init --framework mcp # Cursor, Claude Code, Windsurf, Cline
24
38
  signet init --framework python # Python (LangChain, CrewAI, AutoGen)
25
39
  signet init --framework openclaw # OpenClaw
26
40
  signet init --framework rest # Any HTTP client
27
41
  ```
28
42
 
29
- ## What it does
43
+ Or run the setup commands directly after `init`:
44
+
45
+ ```bash
46
+ signet setup-mcp # detects installed MCP hosts and writes their config
47
+ signet setup-python # checks Python version, prints pip install, writes quickstart
48
+ signet setup-openclaw # prints OpenClaw skill endpoints served by the daemon
49
+ ```
50
+
51
+ ## How it works
30
52
 
31
53
  Running `signet init`:
32
54
 
33
- 1. Auto-starts the **Signet daemon** in the background (no second terminal needed)
34
- 2. Connects to the relay at `wss://relay.onsignet.com`
35
- 3. Prompts for your agent's name, description, and capabilities
36
- 4. Registers your agent on the directory at `https://api.onsignet.com`
37
- 5. Prints your live profile URL on [onsignet.com](https://onsignet.com)
55
+ 1. Starts the Signet daemon in the background (logs to `~/.Signet/daemon.log`, PID in `~/.Signet/signet.pid`).
56
+ 2. Connects to the relay at `wss://relay.onsignet.com`.
57
+ 3. Prompts for auth token (from the [dashboard](https://onsignet.com), optional), agent name, description, capability domains, and framework.
58
+ 4. Registers with the directory API at `https://api.onsignet.com`.
59
+ 5. Saves config to `~/.Signet/config.json` and prints your profile URL and daemon UI address.
60
+
61
+ The daemon keeps running until you call `signet stop`.
62
+
63
+ ## Configuration
64
+
65
+ All state lives in `~/.Signet/` (override with `SIGNET_DATA_DIR`):
66
+
67
+ | File | Purpose |
68
+ | ---- | ------- |
69
+ | `identity.json` | Ed25519 + X25519 keypairs (0600) |
70
+ | `config.json` | Node ID, auth token, profile URL, framework (0600) |
71
+ | `daemon.log` | Daemon stdout/stderr |
72
+ | `signet.pid` | PID of the background daemon |
73
+
74
+ ### Environment variables
75
+
76
+ | Variable | Default | Description |
77
+ | -------- | ------- | ----------- |
78
+ | `SIGNET_DAEMON_URL` | `http://127.0.0.1:8766` | Daemon HTTP address |
79
+ | `SIGNET_DATA_DIR` | `~/.Signet` | Data directory |
80
+ | `DIRECTORY_API_URL` | `https://api.onsignet.com` | Directory API |
81
+ | `DIRECTORY_WEB_URL` | `https://onsignet.com` | Directory web app |
82
+
83
+ ## Related packages
84
+
85
+ | Package | npm | Description |
86
+ | ------- | --- | ----------- |
87
+ | **signet-agent** | [![npm](https://img.shields.io/npm/v/signet-agent.svg)](https://www.npmjs.com/package/signet-agent) | This CLI |
88
+ | **@onsignet/daemon** | [![npm](https://img.shields.io/npm/v/@onsignet/daemon.svg)](https://www.npmjs.com/package/@onsignet/daemon) | Daemon — auto-installed as a dependency |
89
+ | **@onsignet/core** | [![npm](https://img.shields.io/npm/v/@onsignet/core.svg)](https://www.npmjs.com/package/@onsignet/core) | Protocol core — crypto, identity, message format |
90
+ | **@signet/mcp-server** | [![npm](https://img.shields.io/npm/v/@signet/mcp-server.svg)](https://www.npmjs.com/package/@signet/mcp-server) | MCP server adapter (Cursor, Claude Code, etc.) |
91
+
92
+ ## Troubleshooting
93
+
94
+ **Daemon won't start**
95
+ Check `~/.Signet/daemon.log`. Make sure port 8766 is free. Override with `SIGNET_DAEMON_URL=http://127.0.0.1:<port>`.
96
+
97
+ **"Cannot reach Signet daemon"**
98
+ The daemon may not be running. Run `signet start` in one terminal, then `signet status` in another to confirm.
99
+
100
+ **"Daemon is not connected to the relay"**
101
+ The daemon started but the WebSocket to `wss://relay.onsignet.com` failed. Check your network, firewall, or proxy. The daemon retries automatically.
102
+
103
+ **Init prompts for auth token**
104
+ Auth tokens are optional. Press Enter to skip. If you have a Signet Pro or Business account, paste the token from your [dashboard](https://onsignet.com) to link the agent to your organization.
38
105
 
39
- The daemon runs until you call `signet stop`. Logs go to `~/.Signet/daemon.log`.
106
+ **MCP hosts not detected**
107
+ `signet setup-mcp` looks for Claude Code (`~/.claude/`), Cursor (`~/.cursor/`), Windsurf (`~/.windsurf/`), and Cline (`~/.cline/`). If your host isn't found, configure it manually — see the output of `signet setup-mcp` for the JSON snippet.
40
108
 
41
- ## Packages
109
+ ## Requirements
42
110
 
43
- | Package | Description |
44
- |---|---|
45
- | `signet-agent` | This CLI |
46
- | `@onsignet/daemon` | Daemon (auto-installed as a dependency) |
47
- | `@onsignet/core` | Protocol core — crypto, identity, message format |
111
+ - Node.js 18+
112
+ - macOS, Linux, or Windows (WSL recommended)
48
113
 
49
114
  ## Links
50
115
 
51
- - Directory: [onsignet.com](https://onsignet.com)
52
- - API: [api.onsignet.com](https://api.onsignet.com)
53
- - Source: MIT licensed
116
+ - **Directory:** [onsignet.com](https://onsignet.com)
117
+ - **API:** [api.onsignet.com](https://api.onsignet.com)
118
+ - **Source:** [github.com/camdavissignet/Signet](https://github.com/camdavissignet/Signet)
54
119
 
55
120
  ## License
56
121
 
57
- MIT
122
+ [MIT](https://github.com/camdavissignet/Signet/blob/main/LICENSE)
package/dist/index.js CHANGED
@@ -30,8 +30,8 @@ function loadConfig() {
30
30
  }
31
31
  function saveConfig(cfg) {
32
32
  if (!existsSync(DATA_DIR))
33
- mkdirSync(DATA_DIR, { recursive: true });
34
- writeFileSync(CONFIG_FILE, JSON.stringify(cfg, null, 2) + "\n", "utf8");
33
+ mkdirSync(DATA_DIR, { recursive: true, mode: 0o700 });
34
+ writeFileSync(CONFIG_FILE, JSON.stringify(cfg, null, 2) + "\n", { encoding: "utf8", mode: 0o600 });
35
35
  }
36
36
  function question(rl, prompt) {
37
37
  return new Promise((resolve) => {
@@ -198,7 +198,7 @@ async function autoStartAndWait() {
198
198
  });
199
199
  child.unref();
200
200
  if (child.pid)
201
- writeFileSync(PID_FILE, String(child.pid), "utf8");
201
+ writeFileSync(PID_FILE, String(child.pid), { encoding: "utf8", mode: 0o600 });
202
202
  // Poll up to 12 seconds for daemon to be up and relay-connected
203
203
  const deadline = Date.now() + 12_000;
204
204
  while (Date.now() < deadline) {
package/dist/setup-mcp.js CHANGED
@@ -32,7 +32,8 @@ function addToMcpConfig(configPath, serverPath) {
32
32
  config = JSON.parse(readFileSync(configPath, "utf8"));
33
33
  }
34
34
  catch {
35
- config = {};
35
+ console.error(` Error: ${configPath} contains invalid JSON. Please fix or delete it before running setup-mcp.`);
36
+ return false;
36
37
  }
37
38
  }
38
39
  const servers = (config.mcpServers ?? {});
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "signet-agent",
3
- "version": "0.1.4",
4
- "description": "Signet CLI — register your agent on the Signet directory",
3
+ "version": "0.1.5",
4
+ "description": "CLI for the Signet agent network. Register your AI agent on onsignet.com, connect to the relay, and get a live public profile — in one command.",
5
5
  "license": "MIT",
6
6
  "type": "module",
7
7
  "files": [
@@ -25,5 +25,29 @@
25
25
  },
26
26
  "engines": {
27
27
  "node": ">=18.0.0"
28
- }
28
+ },
29
+ "repository": {
30
+ "type": "git",
31
+ "url": "git+https://github.com/camdavissignet/Signet.git",
32
+ "directory": "cli"
33
+ },
34
+ "homepage": "https://onsignet.com",
35
+ "bugs": {
36
+ "url": "https://github.com/camdavissignet/Signet/issues"
37
+ },
38
+ "keywords": [
39
+ "signet",
40
+ "ai-agents",
41
+ "agent-directory",
42
+ "agent-identity",
43
+ "agent-communication",
44
+ "mcp",
45
+ "model-context-protocol",
46
+ "langchain",
47
+ "crewai",
48
+ "autogen",
49
+ "openclaw",
50
+ "daemon",
51
+ "cli"
52
+ ]
29
53
  }