@relaycore/cli 0.1.0 → 0.1.2

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 (2) hide show
  1. package/README.md +116 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,116 @@
1
+ # RelayCore CLI
2
+
3
+ The official command-line interface for **RelayCore**, the agentic finance infrastructure on Cronos. This tool scaffolds projects, manages identities, and spins up local development environments for autonomous agents.
4
+
5
+ 📚 **Full Documentation**: [docs.relaycore.xyz/cli](https://docs.relaycore.xyz/cli/overview)
6
+
7
+ ## Features
8
+
9
+ - **🚀 Scaffold Projects**: Generate production-ready Agent, Service, or Full-Stack templates.
10
+ - **🔐 Identity Management**: Register agents and services on-chain (Cronos).
11
+ - **🛠️ Local Development**: Run a full local stack with MCP server, Next.js dashboard, and hot-reloading.
12
+ - **🤖 MCP Integration**: Built-in support for Model Context Protocol servers.
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ npm install -g @relaycore/cli
18
+
19
+ # or via pnpm
20
+ pnpm add -g @relaycore/cli
21
+ ```
22
+
23
+ ## Quick Start
24
+
25
+ ### 1. Initialize a Project
26
+ Create a new agent project with a standard directory structure:
27
+
28
+ ```bash
29
+ relaycore init my-agent
30
+ # Select template: Agent (MCP), Service (Express), or Full Stack
31
+ cd my-agent
32
+ ```
33
+
34
+ ### 2. Login & Authenticate
35
+ Authenticate your machine to interact with the RelayCore network:
36
+
37
+ ```bash
38
+ relaycore auth login
39
+ # Opens browser to authenticate and saves session
40
+ ```
41
+
42
+ ### 3. Register Identity
43
+ Before you can transact, your agent needs an on-chain identity (Relay ID):
44
+
45
+ ```bash
46
+ # Register an Agent (Consumer)
47
+ relaycore agent register
48
+ # Prompts for: Name, Description, Capabilities
49
+
50
+ # Register a Service (Provider)
51
+ relaycore service register
52
+ # Prompts for: Service Category, Input/Output Schemas, Price
53
+ ```
54
+
55
+ ### 4. Start Development Environment
56
+ Run your agent locally with the RelayCore harness:
57
+
58
+ ```bash
59
+ relaycore dev
60
+ ```
61
+ This command:
62
+ - Starts your **MCP Server** (port 3001)
63
+ - Luanches the **Relay Dashboard** (port 3000)
64
+ - Connects to **Cronos Testnet** via your local wallet configuration
65
+ - Watches for file changes
66
+
67
+ ## Commands Reference
68
+
69
+ ### `init`
70
+ ```bash
71
+ relaycore init <project-name>
72
+ ```
73
+ Scaffolds a new project. You will be prompted to choose a template:
74
+ - **Agent**: Minimal MCP server template.
75
+ - **Service**: Express.js service provider template.
76
+ - **Full**: Monorepo with both + Next.js frontend.
77
+
78
+ ### `auth`
79
+ ```bash
80
+ relaycore auth login # Login via web
81
+ relaycore auth logout # clear local session
82
+ relaycore auth whoami # Show current user details
83
+ ```
84
+
85
+ ### `agent`
86
+ ```bash
87
+ relaycore agent register # Interactively register new agent
88
+ relaycore agent list # List agents owned by you
89
+ relaycore agent update # Update metadata for existing agent
90
+ ```
91
+
92
+ ### `service`
93
+ ```bash
94
+ relaycore service register # Register new service
95
+ relaycore service list # List your services
96
+ ```
97
+
98
+ ### `dev`
99
+ ```bash
100
+ relaycore dev
101
+ ```
102
+ Starts the development studio. Requires a valid `relaycore.config.ts` in the project root.
103
+
104
+ ## Configuration
105
+
106
+ The CLI looks for a `.env` file in your project root for local overrides:
107
+
108
+ ```bash
109
+ RELAY_API_URL=https://api.relaycore.xyz # Default
110
+ RELAY_ENV=testnet # default: testnet
111
+ PRIVATE_KEY=... # Optional: For script deploy
112
+ ```
113
+
114
+ ## License
115
+
116
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@relaycore/cli",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "RelayCore CLI - Production-grade agent platform",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -44,4 +44,4 @@
44
44
  "engines": {
45
45
  "node": ">=18.0.0"
46
46
  }
47
- }
47
+ }