@13rac1/openclaw-plugin-claude-code 1.0.3
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/LICENSE +190 -0
- package/README.md +341 -0
- package/dist/claude-code.d.ts +50 -0
- package/dist/claude-code.d.ts.map +1 -0
- package/dist/claude-code.js +3878 -0
- package/dist/claude-code.js.map +1 -0
- package/dist/index.d.ts +50 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +481 -0
- package/dist/index.js.map +1 -0
- package/dist/podman-runner.d.ts +108 -0
- package/dist/podman-runner.d.ts.map +1 -0
- package/dist/podman-runner.js +537 -0
- package/dist/podman-runner.js.map +1 -0
- package/dist/session-manager.d.ts +96 -0
- package/dist/session-manager.d.ts.map +1 -0
- package/dist/session-manager.js +297 -0
- package/dist/session-manager.js.map +1 -0
- package/dist/test-harness.d.ts +10 -0
- package/dist/test-harness.d.ts.map +1 -0
- package/dist/test-harness.js +134 -0
- package/dist/test-harness.js.map +1 -0
- package/openclaw.plugin.json +88 -0
- package/package.json +77 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
Copyright 2026 Bradley Erickson
|
|
179
|
+
|
|
180
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
181
|
+
you may not use this file except in compliance with the License.
|
|
182
|
+
You may obtain a copy of the License at
|
|
183
|
+
|
|
184
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
185
|
+
|
|
186
|
+
Unless required by applicable law or agreed to in writing, software
|
|
187
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
188
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
189
|
+
See the License for the specific language governing permissions and
|
|
190
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,341 @@
|
|
|
1
|
+
# OpenClaw Plugin: Claude Code
|
|
2
|
+
|
|
3
|
+
[](https://github.com/13rac1/openclaw-plugin-claude-code/actions/workflows/ci.yml)
|
|
4
|
+
[](https://codecov.io/gh/13rac1/openclaw-plugin-claude-code)
|
|
5
|
+
[](https://www.npmjs.com/package/@13rac1/openclaw-plugin-claude-code)
|
|
6
|
+
[](https://opensource.org/licenses/Apache-2.0)
|
|
7
|
+
[](https://nodejs.org/)
|
|
8
|
+
[](https://www.typescriptlang.org/)
|
|
9
|
+
|
|
10
|
+
An [OpenClaw](https://openclaw.ai) plugin that runs Claude Code CLI sessions in isolated Podman (or Docker) containers. This enables OpenClaw agents to delegate complex coding tasks to Claude Code while maintaining security through containerization.
|
|
11
|
+
|
|
12
|
+
## Features
|
|
13
|
+
|
|
14
|
+
- **Isolated Execution**: Each Claude Code session runs in its own container with dropped capabilities
|
|
15
|
+
- **Session Persistence**: Sessions maintain state across multiple interactions
|
|
16
|
+
- **Dual Authentication**: Supports both API key and OAuth/Claude Max credentials
|
|
17
|
+
- **Resource Limits**: Configurable memory, CPU, and PID limits
|
|
18
|
+
- **AppArmor Support**: Optional AppArmor profile for additional security hardening
|
|
19
|
+
- **Automatic Cleanup**: Idle sessions are automatically cleaned up
|
|
20
|
+
|
|
21
|
+
## Requirements
|
|
22
|
+
|
|
23
|
+
- [OpenClaw](https://openclaw.ai) >= 2025.1.0
|
|
24
|
+
- [Podman](https://podman.io) (recommended) or Docker
|
|
25
|
+
- Node.js >= 22
|
|
26
|
+
|
|
27
|
+
## Installation
|
|
28
|
+
|
|
29
|
+
### From npm
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
openclaw plugins install @13rac1/openclaw-plugin-claude-code
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### From GitHub Release
|
|
36
|
+
|
|
37
|
+
Download the release zip from [GitHub Releases](https://github.com/13rac1/openclaw-plugin-claude-code/releases) and extract to your plugins directory:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# Download latest release
|
|
41
|
+
curl -LO https://github.com/13rac1/openclaw-plugin-claude-code/releases/latest/download/openclaw-plugin-claude-code-1.0.0.zip
|
|
42
|
+
|
|
43
|
+
# Extract to plugins directory
|
|
44
|
+
unzip openclaw-plugin-claude-code-1.0.0.zip -d ~/.openclaw/plugins/openclaw-plugin-claude-code
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Container Image
|
|
48
|
+
|
|
49
|
+
The plugin requires a container image with Claude Code CLI installed. Pull the pre-built image:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
podman pull ghcr.io/13rac1/openclaw-claude-code:latest
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Or build it yourself:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
podman build -t ghcr.io/13rac1/openclaw-claude-code:latest .
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Configuration
|
|
62
|
+
|
|
63
|
+
Add to your `openclaw.json`:
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
{
|
|
67
|
+
"plugins": {
|
|
68
|
+
"enabled": true,
|
|
69
|
+
"load": {
|
|
70
|
+
"paths": ["path/to/dist/index.js"]
|
|
71
|
+
},
|
|
72
|
+
"entries": {
|
|
73
|
+
"claude-code": {
|
|
74
|
+
"enabled": true,
|
|
75
|
+
"config": {
|
|
76
|
+
"image": "ghcr.io/13rac1/openclaw-claude-code:latest",
|
|
77
|
+
"runtime": "podman",
|
|
78
|
+
"startupTimeout": 30,
|
|
79
|
+
"idleTimeout": 120,
|
|
80
|
+
"memory": "512m",
|
|
81
|
+
"cpus": "1.0",
|
|
82
|
+
"network": "bridge",
|
|
83
|
+
"sessionsDir": "~/.openclaw/claude-sessions",
|
|
84
|
+
"workspacesDir": "~/.openclaw/workspaces",
|
|
85
|
+
"sessionIdleTimeout": 3600
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Configuration Options
|
|
94
|
+
|
|
95
|
+
| Option | Type | Default | Description |
|
|
96
|
+
|--------|------|---------|-------------|
|
|
97
|
+
| `image` | string | `ghcr.io/13rac1/openclaw-claude-code:latest` | Container image for Claude Code |
|
|
98
|
+
| `runtime` | string | `podman` | Container runtime (`podman` or `docker`) |
|
|
99
|
+
| `startupTimeout` | number | `30` | Seconds to wait for container to produce first output |
|
|
100
|
+
| `idleTimeout` | number | `120` | Kill container after this many seconds of no output |
|
|
101
|
+
| `memory` | string | `512m` | Memory limit for containers |
|
|
102
|
+
| `cpus` | string | `1.0` | CPU limit for containers |
|
|
103
|
+
| `network` | string | `bridge` | Network mode (`none`, `bridge`, `host`) |
|
|
104
|
+
| `sessionsDir` | string | `~/.openclaw/claude-sessions` | Directory for session metadata |
|
|
105
|
+
| `workspacesDir` | string | `~/.openclaw/workspaces` | Directory for session workspaces |
|
|
106
|
+
| `sessionIdleTimeout` | number | `3600` | Cleanup idle sessions after this many seconds |
|
|
107
|
+
| `apparmorProfile` | string | `""` | AppArmor profile name (empty = disabled) |
|
|
108
|
+
| `maxOutputSize` | number | `10485760` | Maximum output size in bytes (10MB default, 0 = unlimited) |
|
|
109
|
+
|
|
110
|
+
## Authentication
|
|
111
|
+
|
|
112
|
+
The plugin supports two authentication methods:
|
|
113
|
+
|
|
114
|
+
### 1. OAuth / Claude Max (Recommended)
|
|
115
|
+
|
|
116
|
+
If you have Claude Max or enterprise OAuth credentials, place your credentials file at:
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
~/.claude/.credentials.json
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
The plugin will automatically copy this file into each container session.
|
|
123
|
+
|
|
124
|
+
### 2. API Key
|
|
125
|
+
|
|
126
|
+
Set the `ANTHROPIC_API_KEY` environment variable:
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
export ANTHROPIC_API_KEY=sk-ant-...
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
**Note**: If both are available, OAuth credentials take precedence.
|
|
133
|
+
|
|
134
|
+
## Registered Tools
|
|
135
|
+
|
|
136
|
+
### `claude_code_start`
|
|
137
|
+
|
|
138
|
+
Start a Claude Code task in the background. Returns immediately with a job ID.
|
|
139
|
+
|
|
140
|
+
**Parameters:**
|
|
141
|
+
- `prompt` (required): The task or prompt to send to Claude Code
|
|
142
|
+
- `session_id` (optional): Session ID to continue a previous session
|
|
143
|
+
|
|
144
|
+
**Returns:** `{ jobId: string, sessionId: string }`
|
|
145
|
+
|
|
146
|
+
### `claude_code_status`
|
|
147
|
+
|
|
148
|
+
Check the status of a running or completed job.
|
|
149
|
+
|
|
150
|
+
**Parameters:**
|
|
151
|
+
- `job_id` (required): Job ID returned from `claude_code_start`
|
|
152
|
+
- `session_id` (optional): Session ID
|
|
153
|
+
|
|
154
|
+
**Returns:** Status, elapsed time, output size, resource metrics, exit code, errors
|
|
155
|
+
|
|
156
|
+
### `claude_code_output`
|
|
157
|
+
|
|
158
|
+
Read or tail output from a job.
|
|
159
|
+
|
|
160
|
+
**Parameters:**
|
|
161
|
+
- `job_id` (required): Job ID
|
|
162
|
+
- `session_id` (optional): Session ID
|
|
163
|
+
- `offset` (optional): Byte offset to start reading from (for tailing)
|
|
164
|
+
- `limit` (optional): Maximum bytes to read (default 64KB)
|
|
165
|
+
|
|
166
|
+
**Returns:** Output content with `hasMore` flag for pagination
|
|
167
|
+
|
|
168
|
+
### `claude_code_cancel`
|
|
169
|
+
|
|
170
|
+
Cancel a running job and stop its container.
|
|
171
|
+
|
|
172
|
+
**Parameters:**
|
|
173
|
+
- `job_id` (required): Job ID
|
|
174
|
+
- `session_id` (optional): Session ID
|
|
175
|
+
|
|
176
|
+
### `claude_code_cleanup`
|
|
177
|
+
|
|
178
|
+
Clean up idle sessions and their jobs.
|
|
179
|
+
|
|
180
|
+
### `claude_code_sessions`
|
|
181
|
+
|
|
182
|
+
List all active sessions with age, last activity, message count, and active job info.
|
|
183
|
+
|
|
184
|
+
## Security
|
|
185
|
+
|
|
186
|
+
The plugin implements multiple layers of security:
|
|
187
|
+
|
|
188
|
+
1. **Rootless Containers**: Uses Podman rootless mode by default
|
|
189
|
+
2. **Capability Dropping**: All Linux capabilities are dropped (`--cap-drop ALL`)
|
|
190
|
+
3. **Resource Limits**: Memory, CPU, and PID limits prevent resource exhaustion
|
|
191
|
+
4. **tmpfs with noexec**: `/tmp` is mounted as tmpfs with `noexec,nosuid`
|
|
192
|
+
5. **Network Isolation**: Configurable network mode (can be set to `none`)
|
|
193
|
+
6. **AppArmor**: Optional AppArmor profile support for MAC enforcement
|
|
194
|
+
|
|
195
|
+
## Development
|
|
196
|
+
|
|
197
|
+
### Setup
|
|
198
|
+
|
|
199
|
+
```bash
|
|
200
|
+
git clone https://github.com/13rac1/openclaw-plugin-claude-code.git
|
|
201
|
+
cd openclaw-plugin-claude-code
|
|
202
|
+
npm install
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### Build
|
|
206
|
+
|
|
207
|
+
```bash
|
|
208
|
+
npm run build
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Test
|
|
212
|
+
|
|
213
|
+
```bash
|
|
214
|
+
# Unit tests (mocked)
|
|
215
|
+
npm test
|
|
216
|
+
|
|
217
|
+
# Integration tests (requires Podman)
|
|
218
|
+
npm run test:integration
|
|
219
|
+
|
|
220
|
+
# All tests
|
|
221
|
+
npm run test:all
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Local Development
|
|
225
|
+
|
|
226
|
+
Link the plugin for development:
|
|
227
|
+
|
|
228
|
+
```bash
|
|
229
|
+
openclaw plugins install -l ./path/to/openclaw-plugin-claude-code
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
## Container Image
|
|
233
|
+
|
|
234
|
+
The included Dockerfile creates a Debian Bookworm-based image with:
|
|
235
|
+
|
|
236
|
+
- Node.js 22
|
|
237
|
+
- Claude Code CLI (npm global)
|
|
238
|
+
- Go 1.22.5 + TinyGo 0.32.0
|
|
239
|
+
- Python 3 with venv
|
|
240
|
+
- Common dev tools: git, ripgrep, jq, curl
|
|
241
|
+
|
|
242
|
+
### Building Multi-arch Images
|
|
243
|
+
|
|
244
|
+
```bash
|
|
245
|
+
# Single architecture (current)
|
|
246
|
+
podman build -t ghcr.io/13rac1/openclaw-claude-code:latest .
|
|
247
|
+
|
|
248
|
+
# Multi-architecture (arm64 + amd64)
|
|
249
|
+
GITHUB_USERNAME=13rac1 ./scripts/build-and-push.sh --multi-arch
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
## Releasing
|
|
253
|
+
|
|
254
|
+
Releases are automated via GitHub Actions when a version tag is pushed.
|
|
255
|
+
|
|
256
|
+
### Prerequisites
|
|
257
|
+
|
|
258
|
+
1. Configure `NPM_TOKEN` secret in GitHub repository settings
|
|
259
|
+
2. Ensure you have push access to the repository
|
|
260
|
+
|
|
261
|
+
### Release Process
|
|
262
|
+
|
|
263
|
+
1. Update version in `package.json`
|
|
264
|
+
2. Update `CHANGELOG.md` with release notes
|
|
265
|
+
3. Commit the changes:
|
|
266
|
+
```bash
|
|
267
|
+
git add package.json CHANGELOG.md
|
|
268
|
+
git commit -m "chore: release v1.x.x"
|
|
269
|
+
```
|
|
270
|
+
4. Create and push a version tag:
|
|
271
|
+
```bash
|
|
272
|
+
git tag v1.x.x
|
|
273
|
+
git push origin main --tags
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
The release workflow will automatically:
|
|
277
|
+
- Run tests
|
|
278
|
+
- Publish to npm with provenance
|
|
279
|
+
- Build and push multi-arch container images to ghcr.io
|
|
280
|
+
|
|
281
|
+
## Troubleshooting
|
|
282
|
+
|
|
283
|
+
### Container image not found
|
|
284
|
+
|
|
285
|
+
```
|
|
286
|
+
Error: Container image not found: ghcr.io/13rac1/openclaw-claude-code:latest
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
Pull or build the container image:
|
|
290
|
+
|
|
291
|
+
```bash
|
|
292
|
+
podman pull ghcr.io/13rac1/openclaw-claude-code:latest
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
### No authentication available
|
|
296
|
+
|
|
297
|
+
```
|
|
298
|
+
Error: No authentication available. Set ANTHROPIC_API_KEY or have ~/.claude/.credentials.json
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
Either:
|
|
302
|
+
1. Set `ANTHROPIC_API_KEY` environment variable, or
|
|
303
|
+
2. Place OAuth credentials at `~/.claude/.credentials.json`
|
|
304
|
+
|
|
305
|
+
### Startup timeout
|
|
306
|
+
|
|
307
|
+
```
|
|
308
|
+
Error: startup_timeout - No output within 30 seconds
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
The container failed to start or produce output. Check:
|
|
312
|
+
- Container image is valid
|
|
313
|
+
- Sufficient system resources
|
|
314
|
+
- Network connectivity (if `network: bridge`)
|
|
315
|
+
|
|
316
|
+
Increase `startupTimeout` if needed.
|
|
317
|
+
|
|
318
|
+
### Idle timeout
|
|
319
|
+
|
|
320
|
+
```
|
|
321
|
+
Error: idle_timeout - No output for 120 seconds
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
Claude Code stopped producing output. This may indicate:
|
|
325
|
+
- Task completed but output wasn't captured
|
|
326
|
+
- Claude Code is stuck
|
|
327
|
+
- Task requires more time (increase `idleTimeout`)
|
|
328
|
+
|
|
329
|
+
## FAQ
|
|
330
|
+
|
|
331
|
+
### Why Podman?
|
|
332
|
+
|
|
333
|
+
The primary reason is rootless. Podman runs containers without root privileges by default, which is essential for a tool that executes arbitrary code from AI agents. Docker can run rootless too, but it requires additional setup and isn't the default mode.
|
|
334
|
+
|
|
335
|
+
## License
|
|
336
|
+
|
|
337
|
+
Apache-2.0 - see [LICENSE](LICENSE)
|
|
338
|
+
|
|
339
|
+
## Contributing
|
|
340
|
+
|
|
341
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Plugin configuration interface
|
|
3
|
+
*/
|
|
4
|
+
export interface ClaudeCodePluginConfig {
|
|
5
|
+
image: string;
|
|
6
|
+
runtime: string;
|
|
7
|
+
startupTimeout: number;
|
|
8
|
+
idleTimeout: number;
|
|
9
|
+
memory: string;
|
|
10
|
+
cpus: string;
|
|
11
|
+
network: string;
|
|
12
|
+
sessionsDir: string;
|
|
13
|
+
workspacesDir: string;
|
|
14
|
+
sessionIdleTimeout: number;
|
|
15
|
+
apparmorProfile?: string;
|
|
16
|
+
maxOutputSize: number;
|
|
17
|
+
}
|
|
18
|
+
/** Tool response content item */
|
|
19
|
+
interface ContentItem {
|
|
20
|
+
type: string;
|
|
21
|
+
text: string;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* OpenClaw Plugin API interface
|
|
25
|
+
*/
|
|
26
|
+
interface PluginApi {
|
|
27
|
+
config: Record<string, unknown>;
|
|
28
|
+
registerTool(config: {
|
|
29
|
+
name: string;
|
|
30
|
+
description: string;
|
|
31
|
+
parameters: unknown;
|
|
32
|
+
execute: (id: string, params: Record<string, unknown>) => Promise<{
|
|
33
|
+
content: ContentItem[];
|
|
34
|
+
}>;
|
|
35
|
+
}): void;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Format milliseconds as human-readable duration
|
|
39
|
+
*/
|
|
40
|
+
export declare function formatDuration(ms: number): string;
|
|
41
|
+
/**
|
|
42
|
+
* Claude Code Plugin for OpenClaw
|
|
43
|
+
*
|
|
44
|
+
* Registers tools that execute prompts in isolated Podman containers
|
|
45
|
+
* running Claude Code CLI.
|
|
46
|
+
*/
|
|
47
|
+
export default function register(api: PluginApi): void;
|
|
48
|
+
export { SessionManager } from "./session-manager.js";
|
|
49
|
+
export { PodmanRunner } from "./podman-runner.js";
|
|
50
|
+
//# sourceMappingURL=claude-code.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"claude-code.d.ts","sourceRoot":"","sources":["../src/claude-code.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;CACvB;AAoBD,iCAAiC;AACjC,UAAU,WAAW;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,UAAU,SAAS;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,YAAY,CAAC,MAAM,EAAE;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC;YAAE,OAAO,EAAE,WAAW,EAAE,CAAA;SAAE,CAAC,CAAC;KAC/F,GAAG,IAAI,CAAC;CACV;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAgBjD;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI,CAydrD;AAoDD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC"}
|