mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-03-30 21:53:28 +08:00
Compare commits
6 Commits
v1.4.1
...
77bb669dc5
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
77bb669dc5 | ||
|
|
b9d09cbebf | ||
|
|
d2191d09a2 | ||
|
|
11ad2a875f | ||
|
|
33186f1a93 | ||
|
|
90ad2f3885 |
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "everything-claude-code",
|
||||
"version": "1.2.0",
|
||||
"version": "1.4.1",
|
||||
"description": "Complete collection of battle-tested Claude Code configs from an Anthropic hackathon winner - agents, skills, hooks, and rules evolved over 10+ months of intensive daily use",
|
||||
"author": {
|
||||
"name": "Affaan Mustafa",
|
||||
|
||||
12
.github/workflows/release.yml
vendored
12
.github/workflows/release.yml
vendored
@@ -25,6 +25,18 @@ jobs:
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Verify plugin.json version matches tag
|
||||
env:
|
||||
TAG_NAME: ${{ github.ref_name }}
|
||||
run: |
|
||||
TAG_VERSION="${TAG_NAME#v}"
|
||||
PLUGIN_VERSION=$(grep -oE '"version": *"[^"]*"' .claude-plugin/plugin.json | grep -oE '[0-9]+\.[0-9]+\.[0-9]+')
|
||||
if [ "$TAG_VERSION" != "$PLUGIN_VERSION" ]; then
|
||||
echo "::error::Tag version ($TAG_VERSION) does not match plugin.json version ($PLUGIN_VERSION)"
|
||||
echo "Run: ./scripts/release.sh $TAG_VERSION"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Generate changelog
|
||||
id: changelog
|
||||
run: |
|
||||
|
||||
83
README.md
83
README.md
@@ -3,12 +3,18 @@
|
||||
# Everything Claude Code
|
||||
|
||||
[](https://github.com/affaan-m/everything-claude-code/stargazers)
|
||||
[](https://github.com/affaan-m/everything-claude-code/network/members)
|
||||
[](https://github.com/affaan-m/everything-claude-code/graphs/contributors)
|
||||
[](LICENSE)
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
> **41K+ stars** | **5K+ forks** | **22 contributors** | **6 languages supported**
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
@@ -61,6 +67,38 @@ This repo is the raw code only. The guides explain everything.
|
||||
|
||||
---
|
||||
|
||||
## What's New
|
||||
|
||||
### v1.4.1 — Bug Fix (Feb 2026)
|
||||
|
||||
- **Fixed instinct import content loss** — `parse_instinct_file()` was silently dropping all content after frontmatter (Action, Evidence, Examples sections) during `/instinct-import`. Fixed by community contributor @ericcai0814 ([#148](https://github.com/affaan-m/everything-claude-code/issues/148), [#161](https://github.com/affaan-m/everything-claude-code/pull/161))
|
||||
|
||||
### v1.4.0 — Multi-Language Rules, Installation Wizard & PM2 (Feb 2026)
|
||||
|
||||
- **Interactive installation wizard** — New `configure-ecc` skill provides guided setup with merge/overwrite detection
|
||||
- **PM2 & multi-agent orchestration** — 6 new commands (`/pm2`, `/multi-plan`, `/multi-execute`, `/multi-backend`, `/multi-frontend`, `/multi-workflow`) for managing complex multi-service workflows
|
||||
- **Multi-language rules architecture** — Rules restructured from flat files into `common/` + `typescript/` + `python/` + `golang/` directories. Install only the languages you need
|
||||
- **Chinese (zh-CN) translations** — Complete translation of all agents, commands, skills, and rules (80+ files)
|
||||
- **GitHub Sponsors support** — Sponsor the project via GitHub Sponsors
|
||||
- **Enhanced CONTRIBUTING.md** — Detailed PR templates for each contribution type
|
||||
|
||||
### v1.3.0 — OpenCode Plugin Support (Feb 2026)
|
||||
|
||||
- **Full OpenCode integration** — 12 agents, 24 commands, 16 skills with hook support via OpenCode's plugin system (20+ event types)
|
||||
- **3 native custom tools** — run-tests, check-coverage, security-audit
|
||||
- **LLM documentation** — `llms.txt` for comprehensive OpenCode docs
|
||||
|
||||
### v1.2.0 — Unified Commands & Skills (Feb 2026)
|
||||
|
||||
- **Python/Django support** — Django patterns, security, TDD, and verification skills
|
||||
- **Java Spring Boot skills** — Patterns, security, TDD, and verification for Spring Boot
|
||||
- **Session management** — `/sessions` command for session history
|
||||
- **Continuous learning v2** — Instinct-based learning with confidence scoring, import/export, evolution
|
||||
|
||||
See the full changelog in [Releases](https://github.com/affaan-m/everything-claude-code/releases).
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
Get up and running in under 2 minutes:
|
||||
@@ -102,7 +140,7 @@ cp -r everything-claude-code/rules/golang/* ~/.claude/rules/
|
||||
/plugin list everything-claude-code@everything-claude-code
|
||||
```
|
||||
|
||||
✨ **That's it!** You now have access to 15+ agents, 30+ skills, and 20+ commands.
|
||||
✨ **That's it!** You now have access to 15+ agents, 30+ skills, and 30+ commands.
|
||||
|
||||
---
|
||||
|
||||
@@ -161,8 +199,10 @@ everything-claude-code/
|
||||
| |-- e2e-runner.md # Playwright E2E testing
|
||||
| |-- refactor-cleaner.md # Dead code cleanup
|
||||
| |-- doc-updater.md # Documentation sync
|
||||
| |-- go-reviewer.md # Go code review (NEW)
|
||||
| |-- go-build-resolver.md # Go build error resolution (NEW)
|
||||
| |-- go-reviewer.md # Go code review
|
||||
| |-- go-build-resolver.md # Go build error resolution
|
||||
| |-- python-reviewer.md # Python code review (NEW)
|
||||
| |-- database-reviewer.md # Database/Supabase review (NEW)
|
||||
|
|
||||
|-- skills/ # Workflow definitions and domain knowledge
|
||||
| |-- coding-standards/ # Language best practices
|
||||
@@ -176,8 +216,19 @@ everything-claude-code/
|
||||
| |-- security-review/ # Security checklist
|
||||
| |-- eval-harness/ # Verification loop evaluation (Longform Guide)
|
||||
| |-- verification-loop/ # Continuous verification (Longform Guide)
|
||||
| |-- golang-patterns/ # Go idioms and best practices (NEW)
|
||||
| |-- golang-testing/ # Go testing patterns, TDD, benchmarks (NEW)
|
||||
| |-- golang-patterns/ # Go idioms and best practices
|
||||
| |-- golang-testing/ # Go testing patterns, TDD, benchmarks
|
||||
| |-- django-patterns/ # Django patterns, models, views (NEW)
|
||||
| |-- django-security/ # Django security best practices (NEW)
|
||||
| |-- django-tdd/ # Django TDD workflow (NEW)
|
||||
| |-- django-verification/ # Django verification loops (NEW)
|
||||
| |-- python-patterns/ # Python idioms and best practices (NEW)
|
||||
| |-- python-testing/ # Python testing with pytest (NEW)
|
||||
| |-- springboot-patterns/ # Java Spring Boot patterns (NEW)
|
||||
| |-- springboot-security/ # Spring Boot security (NEW)
|
||||
| |-- springboot-tdd/ # Spring Boot TDD (NEW)
|
||||
| |-- springboot-verification/ # Spring Boot verification (NEW)
|
||||
| |-- configure-ecc/ # Interactive installation wizard (NEW)
|
||||
|
|
||||
|-- commands/ # Slash commands for quick execution
|
||||
| |-- tdd.md # /tdd - Test-driven development
|
||||
@@ -197,7 +248,13 @@ everything-claude-code/
|
||||
| |-- instinct-status.md # /instinct-status - View learned instincts (NEW)
|
||||
| |-- instinct-import.md # /instinct-import - Import instincts (NEW)
|
||||
| |-- instinct-export.md # /instinct-export - Export instincts (NEW)
|
||||
| |-- evolve.md # /evolve - Cluster instincts into skills (NEW)
|
||||
| |-- evolve.md # /evolve - Cluster instincts into skills
|
||||
| |-- pm2.md # /pm2 - PM2 service lifecycle management (NEW)
|
||||
| |-- multi-plan.md # /multi-plan - Multi-agent task decomposition (NEW)
|
||||
| |-- multi-execute.md # /multi-execute - Orchestrated multi-agent workflows (NEW)
|
||||
| |-- multi-backend.md # /multi-backend - Backend multi-service orchestration (NEW)
|
||||
| |-- multi-frontend.md # /multi-frontend - Frontend multi-service orchestration (NEW)
|
||||
| |-- multi-workflow.md # /multi-workflow - General multi-service workflows (NEW)
|
||||
|
|
||||
|-- rules/ # Always-follow guidelines (copy to ~/.claude/rules/)
|
||||
| |-- README.md # Structure overview and installation guide
|
||||
@@ -511,10 +568,10 @@ Please contribute! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
|
||||
### Ideas for Contributions
|
||||
|
||||
- Language-specific skills (Python, Rust patterns) - Go now included!
|
||||
- Framework-specific configs (Django, Rails, Laravel)
|
||||
- DevOps agents (Kubernetes, Terraform, AWS)
|
||||
- Testing strategies (different frameworks)
|
||||
- Language-specific skills (Rust, C#, Swift, Kotlin) — Go, Python, Java already included
|
||||
- Framework-specific configs (Rails, Laravel, FastAPI, NestJS) — Django, Spring Boot already included
|
||||
- DevOps agents (Kubernetes, Terraform, AWS, Docker)
|
||||
- Testing strategies (different frameworks, visual regression)
|
||||
- Domain-specific knowledge (ML, data engineering, mobile)
|
||||
|
||||
---
|
||||
@@ -539,9 +596,9 @@ The configuration is automatically detected from `.opencode/opencode.json`.
|
||||
|
||||
| Feature | Claude Code | OpenCode | Status |
|
||||
|---------|-------------|----------|--------|
|
||||
| Agents | ✅ 12 agents | ✅ 12 agents | **Full parity** |
|
||||
| Commands | ✅ 23 commands | ✅ 24 commands | **Full parity** |
|
||||
| Skills | ✅ 16 skills | ✅ 16 skills | **Full parity** |
|
||||
| Agents | ✅ 14 agents | ✅ 12 agents | **Claude Code leads** |
|
||||
| Commands | ✅ 30 commands | ✅ 24 commands | **Claude Code leads** |
|
||||
| Skills | ✅ 28 skills | ✅ 16 skills | **Claude Code leads** |
|
||||
| Hooks | ✅ 3 phases | ✅ 20+ events | **OpenCode has more!** |
|
||||
| Rules | ✅ 8 rules | ✅ 8 rules | **Full parity** |
|
||||
| MCP Servers | ✅ Full | ✅ Full | **Full parity** |
|
||||
|
||||
@@ -35,7 +35,7 @@ REPEAT → Next test case
|
||||
|
||||
## Example Session
|
||||
|
||||
````
|
||||
```text
|
||||
User: /go-test I need a function to validate email addresses
|
||||
|
||||
Agent:
|
||||
@@ -167,7 +167,7 @@ ok project/validator 0.003s
|
||||
✓ Coverage: 100%
|
||||
|
||||
## TDD Complete!
|
||||
````
|
||||
```
|
||||
|
||||
## Test Patterns
|
||||
|
||||
|
||||
51
install.sh
Executable file
51
install.sh
Executable file
@@ -0,0 +1,51 @@
|
||||
#!/usr/bin/env bash
|
||||
# install.sh — Install claude rules while preserving directory structure.
|
||||
#
|
||||
# Usage:
|
||||
# ./install.sh <language> [<language> ...]
|
||||
#
|
||||
# Examples:
|
||||
# ./install.sh typescript
|
||||
# ./install.sh typescript python golang
|
||||
#
|
||||
# This script copies rules into ~/.claude/rules/ keeping the common/ and
|
||||
# language-specific subdirectories intact so that:
|
||||
# 1. Files with the same name in common/ and <language>/ don't overwrite
|
||||
# each other.
|
||||
# 2. Relative references (e.g. ../common/coding-style.md) remain valid.
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
RULES_DIR="$(cd "$(dirname "$0")/rules" && pwd)"
|
||||
DEST_DIR="${CLAUDE_RULES_DIR:-$HOME/.claude/rules}"
|
||||
|
||||
if [[ $# -eq 0 ]]; then
|
||||
echo "Usage: $0 <language> [<language> ...]"
|
||||
echo ""
|
||||
echo "Available languages:"
|
||||
for dir in "$RULES_DIR"/*/; do
|
||||
name="$(basename "$dir")"
|
||||
[[ "$name" == "common" ]] && continue
|
||||
echo " - $name"
|
||||
done
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Always install common rules
|
||||
echo "Installing common rules -> $DEST_DIR/common/"
|
||||
mkdir -p "$DEST_DIR/common"
|
||||
cp -r "$RULES_DIR/common/." "$DEST_DIR/common/"
|
||||
|
||||
# Install each requested language
|
||||
for lang in "$@"; do
|
||||
lang_dir="$RULES_DIR/$lang"
|
||||
if [[ ! -d "$lang_dir" ]]; then
|
||||
echo "Warning: rules/$lang/ does not exist, skipping." >&2
|
||||
continue
|
||||
fi
|
||||
echo "Installing $lang rules -> $DEST_DIR/$lang/"
|
||||
mkdir -p "$DEST_DIR/$lang"
|
||||
cp -r "$lang_dir/." "$DEST_DIR/$lang/"
|
||||
done
|
||||
|
||||
echo "Done. Rules installed to $DEST_DIR/"
|
||||
@@ -25,17 +25,36 @@ rules/
|
||||
|
||||
## Installation
|
||||
|
||||
### Option 1: Install Script (Recommended)
|
||||
|
||||
```bash
|
||||
# Install common + one or more language-specific rule sets
|
||||
./install.sh typescript
|
||||
./install.sh python
|
||||
./install.sh golang
|
||||
|
||||
# Install multiple languages at once
|
||||
./install.sh typescript python
|
||||
```
|
||||
|
||||
### Option 2: Manual Installation
|
||||
|
||||
> **Important:** Copy entire directories — do NOT flatten with `/*`.
|
||||
> Common and language-specific directories contain files with the same names.
|
||||
> Flattening them into one directory causes language-specific files to overwrite
|
||||
> common rules, and breaks the relative `../common/` references used by
|
||||
> language-specific files.
|
||||
|
||||
```bash
|
||||
# Install common rules (required for all projects)
|
||||
cp -r rules/common/* ~/.claude/rules/
|
||||
cp -r rules/common ~/.claude/rules/common
|
||||
|
||||
# Install language-specific rules based on your project's tech stack
|
||||
cp -r rules/typescript/* ~/.claude/rules/
|
||||
cp -r rules/python/* ~/.claude/rules/
|
||||
cp -r rules/golang/* ~/.claude/rules/
|
||||
cp -r rules/typescript ~/.claude/rules/typescript
|
||||
cp -r rules/python ~/.claude/rules/python
|
||||
cp -r rules/golang ~/.claude/rules/golang
|
||||
|
||||
# Attention ! ! ! Configure according to your actual project requirements; the configuration here is for reference only.
|
||||
|
||||
```
|
||||
|
||||
## Rules vs Skills
|
||||
|
||||
@@ -10,7 +10,6 @@ const {
|
||||
getClaudeDir,
|
||||
ensureDir,
|
||||
readFile,
|
||||
writeFile,
|
||||
log
|
||||
} = require('./utils');
|
||||
|
||||
|
||||
67
scripts/release.sh
Executable file
67
scripts/release.sh
Executable file
@@ -0,0 +1,67 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
# Release script for bumping plugin version
|
||||
# Usage: ./scripts/release.sh VERSION
|
||||
|
||||
VERSION="${1:-}"
|
||||
PLUGIN_JSON=".claude-plugin/plugin.json"
|
||||
|
||||
# Function to show usage
|
||||
usage() {
|
||||
echo "Usage: $0 VERSION"
|
||||
echo "Example: $0 1.5.0"
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Validate VERSION is provided
|
||||
if [[ -z "$VERSION" ]]; then
|
||||
echo "Error: VERSION argument is required"
|
||||
usage
|
||||
fi
|
||||
|
||||
# Validate VERSION is semver format (X.Y.Z)
|
||||
if ! [[ "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
|
||||
echo "Error: VERSION must be in semver format (e.g., 1.5.0)"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check current branch is main
|
||||
CURRENT_BRANCH=$(git branch --show-current)
|
||||
if [[ "$CURRENT_BRANCH" != "main" ]]; then
|
||||
echo "Error: Must be on main branch (currently on $CURRENT_BRANCH)"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check working tree is clean
|
||||
if ! git diff --quiet || ! git diff --cached --quiet; then
|
||||
echo "Error: Working tree is not clean. Commit or stash changes first."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Verify plugin.json exists
|
||||
if [[ ! -f "$PLUGIN_JSON" ]]; then
|
||||
echo "Error: $PLUGIN_JSON not found"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Read current version
|
||||
OLD_VERSION=$(grep -oE '"version": *"[^"]*"' "$PLUGIN_JSON" | grep -oE '[0-9]+\.[0-9]+\.[0-9]+')
|
||||
echo "Bumping version: $OLD_VERSION -> $VERSION"
|
||||
|
||||
# Update version in plugin.json (cross-platform sed)
|
||||
if [[ "$OSTYPE" == "darwin"* ]]; then
|
||||
# macOS
|
||||
sed -i '' "s/\"version\": *\"[^\"]*\"/\"version\": \"$VERSION\"/" "$PLUGIN_JSON"
|
||||
else
|
||||
# Linux
|
||||
sed -i "s/\"version\": *\"[^\"]*\"/\"version\": \"$VERSION\"/" "$PLUGIN_JSON"
|
||||
fi
|
||||
|
||||
# Stage, commit, tag, and push
|
||||
git add "$PLUGIN_JSON"
|
||||
git commit -m "chore: bump plugin version to $VERSION"
|
||||
git tag "v$VERSION"
|
||||
git push origin main "v$VERSION"
|
||||
|
||||
echo "Released v$VERSION"
|
||||
165
skills/nutrient-document-processing/SKILL.md
Normal file
165
skills/nutrient-document-processing/SKILL.md
Normal file
@@ -0,0 +1,165 @@
|
||||
---
|
||||
name: nutrient-document-processing
|
||||
description: Process, convert, OCR, extract, redact, sign, and fill documents using the Nutrient DWS API. Works with PDFs, DOCX, XLSX, PPTX, HTML, and images.
|
||||
---
|
||||
|
||||
# Nutrient Document Processing
|
||||
|
||||
Process documents with the [Nutrient DWS Processor API](https://www.nutrient.io/api/). Convert formats, extract text and tables, OCR scanned documents, redact PII, add watermarks, digitally sign, and fill PDF forms.
|
||||
|
||||
## Setup
|
||||
|
||||
Get a free API key at **https://dashboard.nutrient.io/sign_up/?product=processor**
|
||||
|
||||
```bash
|
||||
export NUTRIENT_API_KEY="pdf_live_..."
|
||||
```
|
||||
|
||||
All requests go to `https://api.nutrient.io/build` as multipart POST with an `instructions` JSON field.
|
||||
|
||||
## Operations
|
||||
|
||||
### Convert Documents
|
||||
|
||||
```bash
|
||||
# DOCX to PDF
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "document.docx=@document.docx" \
|
||||
-F 'instructions={"parts":[{"file":"document.docx"}]}' \
|
||||
-o output.pdf
|
||||
|
||||
# PDF to DOCX
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "document.pdf=@document.pdf" \
|
||||
-F 'instructions={"parts":[{"file":"document.pdf"}],"output":{"type":"docx"}}' \
|
||||
-o output.docx
|
||||
|
||||
# HTML to PDF
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "index.html=@index.html" \
|
||||
-F 'instructions={"parts":[{"html":"index.html"}]}' \
|
||||
-o output.pdf
|
||||
```
|
||||
|
||||
Supported inputs: PDF, DOCX, XLSX, PPTX, DOC, XLS, PPT, PPS, PPSX, ODT, RTF, HTML, JPG, PNG, TIFF, HEIC, GIF, WebP, SVG, TGA, EPS.
|
||||
|
||||
### Extract Text and Data
|
||||
|
||||
```bash
|
||||
# Extract plain text
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "document.pdf=@document.pdf" \
|
||||
-F 'instructions={"parts":[{"file":"document.pdf"}],"output":{"type":"text"}}' \
|
||||
-o output.txt
|
||||
|
||||
# Extract tables as Excel
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "document.pdf=@document.pdf" \
|
||||
-F 'instructions={"parts":[{"file":"document.pdf"}],"output":{"type":"xlsx"}}' \
|
||||
-o tables.xlsx
|
||||
```
|
||||
|
||||
### OCR Scanned Documents
|
||||
|
||||
```bash
|
||||
# OCR to searchable PDF (supports 100+ languages)
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "scanned.pdf=@scanned.pdf" \
|
||||
-F 'instructions={"parts":[{"file":"scanned.pdf"}],"actions":[{"type":"ocr","language":"english"}]}' \
|
||||
-o searchable.pdf
|
||||
```
|
||||
|
||||
Languages: Supports 100+ languages via ISO 639-2 codes (e.g., `eng`, `deu`, `fra`, `spa`, `jpn`, `kor`, `chi_sim`, `chi_tra`, `ara`, `hin`, `rus`). Full language names like `english` or `german` also work. See the [complete OCR language table](https://www.nutrient.io/guides/document-engine/ocr/language-support/) for all supported codes.
|
||||
|
||||
### Redact Sensitive Information
|
||||
|
||||
```bash
|
||||
# Pattern-based (SSN, email)
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "document.pdf=@document.pdf" \
|
||||
-F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"redaction","strategy":"preset","strategyOptions":{"preset":"social-security-number"}},{"type":"redaction","strategy":"preset","strategyOptions":{"preset":"email-address"}}]}' \
|
||||
-o redacted.pdf
|
||||
|
||||
# Regex-based
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "document.pdf=@document.pdf" \
|
||||
-F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"redaction","strategy":"regex","strategyOptions":{"regex":"\\b[A-Z]{2}\\d{6}\\b"}}]}' \
|
||||
-o redacted.pdf
|
||||
```
|
||||
|
||||
Presets: `social-security-number`, `email-address`, `credit-card-number`, `international-phone-number`, `north-american-phone-number`, `date`, `time`, `url`, `ipv4`, `ipv6`, `mac-address`, `us-zip-code`, `vin`.
|
||||
|
||||
### Add Watermarks
|
||||
|
||||
```bash
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "document.pdf=@document.pdf" \
|
||||
-F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"watermark","text":"CONFIDENTIAL","fontSize":72,"opacity":0.3,"rotation":-45}]}' \
|
||||
-o watermarked.pdf
|
||||
```
|
||||
|
||||
### Digital Signatures
|
||||
|
||||
```bash
|
||||
# Self-signed CMS signature
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "document.pdf=@document.pdf" \
|
||||
-F 'instructions={"parts":[{"file":"document.pdf"}],"actions":[{"type":"sign","signatureType":"cms"}]}' \
|
||||
-o signed.pdf
|
||||
```
|
||||
|
||||
### Fill PDF Forms
|
||||
|
||||
```bash
|
||||
curl -X POST https://api.nutrient.io/build \
|
||||
-H "Authorization: Bearer $NUTRIENT_API_KEY" \
|
||||
-F "form.pdf=@form.pdf" \
|
||||
-F 'instructions={"parts":[{"file":"form.pdf"}],"actions":[{"type":"fillForm","formFields":{"name":"Jane Smith","email":"jane@example.com","date":"2026-02-06"}}]}' \
|
||||
-o filled.pdf
|
||||
```
|
||||
|
||||
## MCP Server (Alternative)
|
||||
|
||||
For native tool integration, use the MCP server instead of curl:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"nutrient-dws": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "@nutrient-sdk/dws-mcp-server"],
|
||||
"env": {
|
||||
"NUTRIENT_DWS_API_KEY": "YOUR_API_KEY",
|
||||
"SANDBOX_PATH": "/path/to/working/directory"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## When to Use
|
||||
|
||||
- Converting documents between formats (PDF, DOCX, XLSX, PPTX, HTML, images)
|
||||
- Extracting text, tables, or key-value pairs from PDFs
|
||||
- OCR on scanned documents or images
|
||||
- Redacting PII before sharing documents
|
||||
- Adding watermarks to drafts or confidential documents
|
||||
- Digitally signing contracts or agreements
|
||||
- Filling PDF forms programmatically
|
||||
|
||||
## Links
|
||||
|
||||
- [API Playground](https://dashboard.nutrient.io/processor-api/playground/)
|
||||
- [Full API Docs](https://www.nutrient.io/guides/dws-processor/)
|
||||
- [Agent Skill Repo](https://github.com/PSPDFKit-labs/nutrient-agent-skill)
|
||||
- [npm MCP Server](https://www.npmjs.com/package/@nutrient-sdk/dws-mcp-server)
|
||||
Reference in New Issue
Block a user