@relaycore/cli 0.1.1 → 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.
- package/README.md +90 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,39 +1,116 @@
|
|
|
1
1
|
# RelayCore CLI
|
|
2
2
|
|
|
3
|
-
The official command-line interface for RelayCore
|
|
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.
|
|
4
13
|
|
|
5
14
|
## Installation
|
|
6
15
|
|
|
7
16
|
```bash
|
|
8
17
|
npm install -g @relaycore/cli
|
|
9
|
-
|
|
18
|
+
|
|
19
|
+
# or via pnpm
|
|
10
20
|
pnpm add -g @relaycore/cli
|
|
11
21
|
```
|
|
12
22
|
|
|
13
|
-
##
|
|
23
|
+
## Quick Start
|
|
14
24
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
relaycore auth login
|
|
18
|
-
```
|
|
25
|
+
### 1. Initialize a Project
|
|
26
|
+
Create a new agent project with a standard directory structure:
|
|
19
27
|
|
|
20
|
-
Initialize a new agent project:
|
|
21
28
|
```bash
|
|
22
29
|
relaycore init my-agent
|
|
30
|
+
# Select template: Agent (MCP), Service (Express), or Full Stack
|
|
23
31
|
cd my-agent
|
|
24
32
|
```
|
|
25
33
|
|
|
26
|
-
|
|
34
|
+
### 2. Login & Authenticate
|
|
35
|
+
Authenticate your machine to interact with the RelayCore network:
|
|
36
|
+
|
|
27
37
|
```bash
|
|
28
|
-
relaycore
|
|
38
|
+
relaycore auth login
|
|
39
|
+
# Opens browser to authenticate and saves session
|
|
29
40
|
```
|
|
30
41
|
|
|
31
|
-
|
|
42
|
+
### 3. Register Identity
|
|
43
|
+
Before you can transact, your agent needs an on-chain identity (Relay ID):
|
|
44
|
+
|
|
32
45
|
```bash
|
|
46
|
+
# Register an Agent (Consumer)
|
|
33
47
|
relaycore agent register
|
|
48
|
+
# Prompts for: Name, Description, Capabilities
|
|
49
|
+
|
|
50
|
+
# Register a Service (Provider)
|
|
34
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
|
|
35
112
|
```
|
|
36
113
|
|
|
37
|
-
##
|
|
114
|
+
## License
|
|
38
115
|
|
|
39
|
-
|
|
116
|
+
MIT
|