-
-
Notifications
You must be signed in to change notification settings - Fork 2
plugin plugin pty
plugin-pty provides a WebSocket PTY bridge for ClawDE AI sessions. It connects the
ClawDE daemon to the nSelf backend via a persistent pseudo-terminal, enabling full
terminal-native AI interaction with session tracking and security audit logging.
Port: 9100 | Bundle: ClawDE | Tier: Paid | License: Required
nself plugin install plugin-ptySet license via environment:
export NSELF_LICENSE_KEY=your-clawde-license-keyClawDE Daemon ─── WebSocket (ws://:9100/ws) ─── plugin-pty ─── PTY ─── ClawDE Binary
│
Postgres (np_pty_*)
The PTY exec target is configured once at startup via PTY_CLAWDE_BINARY_PATH. This
path is never overridable per WebSocket request — preventing shell injection.
| Variable | Required | Default | Description |
|---|---|---|---|
DATABASE_URL |
Yes | — | Postgres connection string |
NSELF_LICENSE_KEY |
Yes | — | ClawDE or ɳSelf+ license key |
PTY_CLAWDE_BINARY_PATH |
No | /usr/local/bin/clawde |
Fixed ClawDE binary path |
PTY_MAX_SESSIONS |
No | 50 |
Concurrent session limit |
PTY_SESSION_TIMEOUT_SECONDS |
No | 3600 |
Idle timeout |
PORT |
No | 9100 |
HTTP/WS listen port |
GET /health
→ {"status":"ok","plugin":"plugin-pty","port":9100}
GET /ws?client_id=<id>
Upgrade: websocket
X-Nself-License: <key>
X-Source-Account-ID: <account-id>
After upgrade, the connection is a bidirectional byte stream to the PTY process. Send keyboard input as raw bytes; receive terminal output as raw bytes.
GET /sessions
X-Nself-License: <key>
X-Source-Account-ID: <account-id>
→ [{"id":"...","client_id":"...","status":"open","cols":80,"rows":24,...}]
| Column | Type | Description |
|---|---|---|
id |
UUID | Primary key |
source_account_id |
TEXT | Tenant isolation (Convention Wall) |
client_id |
TEXT | ClawDE daemon client identifier |
pid |
INTEGER | OS process ID of PTY process |
status |
VARCHAR |
open / closed / error
|
cols, rows
|
INTEGER | Terminal dimensions |
opened_at |
TIMESTAMPTZ | Session start time |
closed_at |
TIMESTAMPTZ | Session end time (null if open) |
error_message |
TEXT | Error detail if status=error |
| Column | Type | Description |
|---|---|---|
id |
UUID | Primary key |
source_account_id |
TEXT | Tenant isolation |
session_id |
UUID | FK → np_pty_sessions |
event_type |
VARCHAR |
session_open / session_close / resize / error
|
detail |
JSONB | Event-specific metadata |
created_at |
TIMESTAMPTZ | Event timestamp |
-
No shell injection —
PTY_CLAWDE_BINARY_PATHis set at server startup only; no per-request override is possible -
License gate — every
/sessionsrequest and WebSocket upgrade requiresX-Nself-Licenseheader matchingNSELF_LICENSE_KEY -
Tenant isolation — all rows scoped by
source_account_id; Hasura RLS enforced -
Audit trail — every session event written to
np_pty_audit_log
filter:
source_account_id:
_eq: X-Hasura-Source-Account-Iddocker run -d \
--name plugin-pty \
-p 9100:9100 \
-e DATABASE_URL="postgres://user:pass@host/db" \
-e NSELF_LICENSE_KEY="<key>" \
nself/plugin-pty:latest- 1.0.0 — Initial release (ClawDE bundle, port 9100, PTY bridge + audit log)
ɳSelf CLI v1.0.9. MIT licensed. Docs CC BY 4.0.
GitHub · Issues · Discussions · nself.org · docs.nself.org
Getting Started
Commands
- Commands, Overview
- Lifecycle: cmd-init · cmd-build · cmd-start · cmd-stop · cmd-restart · cmd-dev
- Monitoring: cmd-status · cmd-logs · cmd-health · cmd-urls · cmd-doctor · cmd-monitor · cmd-alerts · cmd-sentry · cmd-watchdog · cmd-dogfood
- Data: cmd-db · cmd-backup · cmd-dr · cmd-queue · cmd-webhooks
- Config: cmd-config · cmd-service · cmd-env · cmd-promote
- Networking: cmd-ssl · cmd-trust · cmd-dns-setup
- Security: cmd-security · cmd-secrets · cmd-waf
- Tenancy: cmd-tenant · cmd-billing
- Plugins: cmd-plugin · cmd-license
- AI: cmd-ai · cmd-claw · cmd-model
- Templates: cmd-template
- Utilities: cmd-exec · cmd-clean · cmd-reset · cmd-update · cmd-upgrade · cmd-version · cmd-admin · cmd-migrate · cmd-migrate-firebase · cmd-migrate-supabase · cmd-completion
Features
- Features, Overview
- Feature-Auth
- Feature-Storage
- Feature-Search
- Feature-Functions
- Feature-Email
- Feature-Monitoring
- Feature-Plugins
- Feature-ɳClaw, AI Assistant
- Feature-ɳChat, Messaging
- Feature-ɳTV, Media Player
- Feature-ɳFamily, Family Social
- Feature-ɳCloud, Managed Hosting
- Feature-Memory-Rooms, Knowledge Organization
- Feature-Agent-Dashboard, Agent Metrics
- Feature-Image-Generation, AI Image Generation
Configuration
- Configuration, Overview
- Config-Env-Vars
- Config-Postgres
- Config-Hasura
- Config-Auth
- Config-Nginx
- Config-Optional-Services
- Config-Custom-Services
- Config-System
Plugins (87 + 10 monitoring)
Free (25)
- plugin-backup
- plugin-content-acquisition
- plugin-content-progress
- plugin-cron
- plugin-donorbox
- plugin-feature-flags
- plugin-github
- plugin-github-runner
- plugin-invitations
- plugin-jobs
- plugin-link-preview
- plugin-mdns
- plugin-mlflow
- plugin-monitoring
- plugin-notifications
- plugin-notify
- plugin-paypal
- plugin-search
- plugin-shopify
- plugin-stripe
- plugin-subtitle-manager
- plugin-tokens
- plugin-torrent-manager
- plugin-vpn
- plugin-webhooks
Pro (62)
- plugin-access-controls
- plugin-activity-feed
- plugin-admin-api
- nself-ai-gateway
- nself-ai-cc
- nself-ai-mcp
- plugin-analytics
- plugin-auth
- plugin-backup-pro
- plugin-bots
- plugin-browser
- plugin-calendar
- plugin-cdn
- plugin-chat
- plugin-claw
- plugin-claw-budget
- plugin-claw-news
- plugin-claw-web
- plugin-cloudflare
- plugin-cms
- plugin-compliance
- plugin-cron-pro
- plugin-ddns
- plugin-devices
- plugin-documents
- plugin-donorbox-pro
- plugin-entitlements
- plugin-epg
- plugin-file-processing
- plugin-game-metadata
- plugin-geocoding
- plugin-geolocation
- plugin-google
- plugin-home
- plugin-idme
- plugin-knowledge-base
- plugin-linkedin
- plugin-livekit
- plugin-media-processing
- plugin-meetings
- plugin-moderation
- plugin-mux
- plugin-notify-pro
- plugin-object-storage
- plugin-observability
- plugin-paypal-pro
- plugin-photos
- plugin-podcast
- plugin-post
- plugin-realtime
- plugin-recording
- plugin-retro-gaming
- plugin-rom-discovery
- plugin-shopify-pro
- plugin-social
- plugin-sports
- plugin-stream-gateway
- plugin-streaming
- plugin-stripe-pro
- plugin-support
- plugin-tmdb
- plugin-voice
- plugin-web3
- plugin-workflows
Planned (26)
plugin-auditplugin-blogplugin-checkoutplugin-commerceplugin-drmplugin-exportplugin-flowplugin-importplugin-ldapplugin-mailgunplugin-mediaplugin-oauth-providersplugin-pagesplugin-postmarkplugin-rate-limitplugin-reportsplugin-samlplugin-schedulerplugin-sendgridplugin-ssoplugin-subscriptionplugin-thumbplugin-transcoderplugin-twilioplugin-wafplugin-watermark
Guides
- Guide-Production-Deployment
- Guide-SSL-Setup
- Guide-Multi-Tenancy
- Guide-Security-Hardening
- Guide-Monitoring-Setup
- Guide-Backup-Restore
- Guide-Custom-Services
- Guide-Migration-from-v1
Architecture
Reference
- API-Reference
- reference-error-codes, Error Codes
Licensing
Security
Brand
Operations
- operations/release-cascade, Release Cascade
- operations/self-healing, Self-Healing Schema
- operations/redis-tuning, Redis Pool Tuning
- operations/meilisearch-warmup, MeiliSearch Warm-Up
- operations/jwt-rotation, JWT Key Rotation
- operations/windows-wsl2-setup, Windows / WSL2 Setup
- operations/gemini-oauth-reauth, Gemini OAuth Reauth
Contributing
Admin
- USER-ACTION-QUEUE, Pending Admin Actions