@artyfacts/openclaw 0.1.0
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 +92 -0
- package/bin/artyfacts-openclaw.js +2 -0
- package/dist/chunk-CTWVGZRX.mjs +1119 -0
- package/dist/chunk-TT3SG5BN.mjs +987 -0
- package/dist/cli.d.mts +1 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +1508 -0
- package/dist/cli.mjs +391 -0
- package/dist/index.d.mts +446 -0
- package/dist/index.d.ts +446 -0
- package/dist/index.js +1172 -0
- package/dist/index.mjs +36 -0
- package/package.json +64 -0
package/README.md
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# @artyfacts/openclaw
|
|
2
|
+
|
|
3
|
+
OpenClaw adapter for Artyfacts - Execute tasks using the OpenClaw CLI.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @artyfacts/openclaw
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Prerequisites
|
|
12
|
+
|
|
13
|
+
- [OpenClaw CLI](https://openclaw.ai) installed and configured
|
|
14
|
+
- Artyfacts account with agent credentials
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
### 1. Authenticate
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx @artyfacts/openclaw login
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
This will open a device authentication flow. Enter the code at artyfacts.dev/auth/device.
|
|
25
|
+
|
|
26
|
+
### 2. Start Listening for Tasks
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx @artyfacts/openclaw
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
The adapter will:
|
|
33
|
+
1. Connect to Artyfacts via SSE
|
|
34
|
+
2. Configure Artyfacts MCP tools in OpenClaw (first run)
|
|
35
|
+
3. Listen for task assignments
|
|
36
|
+
4. Execute tasks using OpenClaw CLI
|
|
37
|
+
5. Report results back to Artyfacts
|
|
38
|
+
|
|
39
|
+
### 3. Check Status
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npx @artyfacts/openclaw status
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Commands
|
|
46
|
+
|
|
47
|
+
| Command | Description |
|
|
48
|
+
|---------|-------------|
|
|
49
|
+
| `run` (default) | Start listening for and executing tasks |
|
|
50
|
+
| `login` | Authenticate with Artyfacts |
|
|
51
|
+
| `logout` | Clear stored credentials |
|
|
52
|
+
| `status` | Check authentication and connection status |
|
|
53
|
+
| `configure` | Manually configure MCP tools |
|
|
54
|
+
|
|
55
|
+
## Options
|
|
56
|
+
|
|
57
|
+
### run
|
|
58
|
+
|
|
59
|
+
- `--base-url <url>` - Artyfacts API base URL (default: https://artyfacts.dev/api/v1)
|
|
60
|
+
- `--dry-run` - Print tasks but do not execute
|
|
61
|
+
- `--openclaw-path <path>` - Path to openclaw CLI (default: openclaw)
|
|
62
|
+
|
|
63
|
+
### login
|
|
64
|
+
|
|
65
|
+
- `--manual` - Enter credentials manually instead of device auth
|
|
66
|
+
- `--base-url <url>` - Artyfacts API base URL
|
|
67
|
+
|
|
68
|
+
## How It Works
|
|
69
|
+
|
|
70
|
+
1. **Authentication**: Uses device auth flow to obtain API credentials
|
|
71
|
+
2. **MCP Configuration**: Configures `@artyfacts/mcp-server` in OpenClaw
|
|
72
|
+
3. **Task Listening**: Connects to Artyfacts SSE endpoint for real-time task assignments
|
|
73
|
+
4. **Execution**: Runs tasks via `openclaw prompt` with Artyfacts MCP tools
|
|
74
|
+
5. **Reporting**: Reports task results back to Artyfacts API
|
|
75
|
+
|
|
76
|
+
## MCP Tools Available
|
|
77
|
+
|
|
78
|
+
When running, your OpenClaw agent has access to these Artyfacts tools:
|
|
79
|
+
|
|
80
|
+
- `create_artifact` - Create new artifacts (documents, specs, reports)
|
|
81
|
+
- `create_section` - Add sections to artifacts
|
|
82
|
+
- `update_section` - Update existing sections
|
|
83
|
+
- `create_agent` - Create new AI agents
|
|
84
|
+
- `list_artifacts` - Query existing artifacts
|
|
85
|
+
- `list_sections` - Query sections within an artifact
|
|
86
|
+
- `complete_task` - Mark a task as complete
|
|
87
|
+
- `block_task` - Block a task with a reason
|
|
88
|
+
- `create_blocker` - Create a decision blocker
|
|
89
|
+
|
|
90
|
+
## License
|
|
91
|
+
|
|
92
|
+
MIT
|