Local Setup¶

Set up the plugin for local development and testing.

Prerequisites¶

Node.js 18+
npm
OpenClaw CLI installed
Prisma AIRS API key (for live testing)

Clone and Install¶

# Clone repository
git clone https://github.com/cdot65/prisma-airs-plugin-openclaw.git
cd prisma-airs-plugin-openclaw/prisma-airs-plugin

# Install dependencies
npm install

Development Commands¶

# Type checking
npm run typecheck

# Linting
npm run lint
npm run lint:fix

# Formatting
npm run format
npm run format:check

# Tests
npm test
npm run test:watch
npm run test:coverage

# Full check suite
npm run check

Install to OpenClaw¶

From Local Directory¶

# Build and install
openclaw plugins install .

# Restart gateway
openclaw gateway restart

Verify Installation¶

# Check plugin loaded
openclaw plugins list | grep prisma

# Check status (will show missing API key)
openclaw prisma-airs

Configure API Key¶

Set the API key in plugin config (via gateway web UI or config file):

plugins:
  prisma-airs:
    config:
      api_key: "your-api-key"

Test the Plugin¶

CLI Scan¶

openclaw prisma-airs-scan "test message"

RPC Call¶

openclaw gateway call prisma-airs.scan --params '{"prompt":"test"}'

Check Status¶

openclaw prisma-airs

Expected output:

Prisma AIRS Plugin Status
-------------------------
Version: 0.2.4
Profile: default
App Name: openclaw
Reminder: true
API Key: configured

Development Workflow¶

1. Make Changes¶

Edit files in prisma-airs-plugin/.

2. Run Tests¶

npm test

3. Reinstall Plugin¶

openclaw plugins uninstall prisma-airs
openclaw plugins install .
openclaw gateway restart

4. Test Changes¶

openclaw prisma-airs-scan "test your changes"

Debugging¶

View Gateway Logs¶

# macOS/Linux
tail -f ~/.openclaw/logs/gateway.log

# Or use OpenClaw CLI
openclaw gateway logs

Enable Debug Logging¶

Set log level in OpenClaw config:

logging:
  level: debug

Test Hook Output¶

Hooks log to console:

# View hook audit logs
grep "prisma_airs" ~/.openclaw/logs/gateway.log

Testing Without API Key¶

For unit tests, the API is mocked. For manual testing without an API key:

# Will return error response
openclaw prisma-airs-scan "test"

# Expected output
[--] LOW
Action: warn
Categories: api_error
Error: API key not configured. Set it in plugin config.

Project Structure¶

prisma-airs-plugin-openclaw/
├── prisma-airs-plugin/      # Plugin source
│   ├── index.ts             # Plugin entrypoint
│   ├── package.json
│   ├── tsconfig.json
│   ├── vitest.config.ts
│   ├── src/                 # Core modules
│   │   ├── scanner.ts
│   │   └── scan-cache.ts
│   ├── hooks/               # Hook handlers
│   │   ├── prisma-airs-guard/
│   │   ├── prisma-airs-audit/
│   │   ├── prisma-airs-context/
│   │   ├── prisma-airs-outbound/
│   │   └── prisma-airs-tools/
│   └── docs/                # Documentation
├── README.md
├── RELEASE_NOTES.md
└── .github/workflows/       # CI/CD

Common Issues¶

Plugin Not Loading¶

# Check for errors
openclaw plugins list

# Reinstall
openclaw plugins uninstall prisma-airs
openclaw plugins install .
openclaw gateway restart

TypeScript Errors¶

# Run type check
npm run typecheck

# Fix common issues
npm run lint:fix

Tests Failing¶

# Run with verbose output
npm test -- --reporter=verbose

# Run specific test
npm test -- --filter "test name"

API Key Not Working¶

# Check gateway has key
openclaw prisma-airs
# Should show: API Key: configured

# If showing MISSING, set it in plugin config:
# plugins.entries.prisma-airs.config.api_key