Update package name to @farhoodliquor scope and refresh README

- Rename to @farhoodliquor/paperclip-adapter-opencode-k8s
- Add .gitignore
- Emphasize RWX PVC requirement in README

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-04-11 23:18:12 -04:00
parent be7c525063
commit 75f54b1edc
3 changed files with 9 additions and 5 deletions
+4
View File
@@ -0,0 +1,4 @@
node_modules/
dist/
.DS_Store
*.local
+4 -4
View File
@@ -1,4 +1,4 @@
# paperclip-adapter-opencode-k8s # @farhoodliquor/paperclip-adapter-opencode-k8s
Paperclip adapter plugin that runs OpenCode agents as isolated Kubernetes Jobs instead of inside the main Paperclip process. Paperclip adapter plugin that runs OpenCode agents as isolated Kubernetes Jobs instead of inside the main Paperclip process.
@@ -19,7 +19,7 @@ Paperclip adapter plugin that runs OpenCode agents as isolated Kubernetes Jobs i
```bash ```bash
curl -X POST http://localhost:3100/api/adapters \ curl -X POST http://localhost:3100/api/adapters \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{"packageName": "paperclip-adapter-opencode-k8s"}' -d '{"packageName": "@farhoodliquor/paperclip-adapter-opencode-k8s"}'
``` ```
### Local Development ### Local Development
@@ -27,7 +27,7 @@ curl -X POST http://localhost:3100/api/adapters \
```bash ```bash
curl -X POST http://localhost:3100/api/adapters \ curl -X POST http://localhost:3100/api/adapters \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{"localPath": "/path/to/paperclip-opencode-k8s"}' -d '{"localPath": "/path/to/paperclip-adapter-opencode-k8s"}'
``` ```
## Configuration ## Configuration
@@ -45,8 +45,8 @@ See the agent configuration documentation for all available fields:
## Requirements ## Requirements
- **Paperclip must be deployed on a Kubernetes cluster with a shared RWX PVC mounted at `/paperclip`** — this is required for session resume and workspace sharing between the Paperclip pod and agent Job pods
- Kubernetes cluster with RBAC permissions to create Jobs, list Pods, and read Pod logs - Kubernetes cluster with RBAC permissions to create Jobs, list Pods, and read Pod logs
- Shared RWX PVC mounted at `/paperclip` for session resume and workspace access
- `@paperclipai/adapter-utils` >= 0.3.0 - `@paperclipai/adapter-utils` >= 0.3.0
## License ## License
+1 -1
View File
@@ -1,5 +1,5 @@
{ {
"name": "paperclip-adapter-opencode-k8s", "name": "@farhoodliquor/paperclip-adapter-opencode-k8s",
"version": "0.1.0", "version": "0.1.0",
"description": "Paperclip adapter plugin that runs OpenCode agents as Kubernetes Jobs", "description": "Paperclip adapter plugin that runs OpenCode agents as Kubernetes Jobs",
"license": "MIT", "license": "MIT",