Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions apps/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,14 @@ superdoc search "Article 7" ./**/*.docx --json

## AI Integration

Works with AI coding assistants. Add a skill file so Claude Code, Cursor, etc. know to use `superdoc` for DOCX operations instead of python-docx.
Works with AI coding assistants. Copy the skill file so Claude Code, Cursor, etc. know to use `superdoc` for DOCX operations instead of python-docx.

*Skill setup guide coming soon.*
```bash
# Copy skill to Claude Code
cp -r skills/superdoc ~/.claude/skills/
```

See [`skills/superdoc/SKILL.md`](../../skills/superdoc/SKILL.md) for the skill definition.

## Part of SuperDoc

Expand Down
2 changes: 1 addition & 1 deletion apps/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"release:dry-run": "pnpx semantic-release --dry-run"
},
"dependencies": {
"fast-glob": "^3.3.2",
"fast-glob": "catalog:",
"superdoc": "workspace:*"
},
"devDependencies": {
Expand Down
5 changes: 4 additions & 1 deletion pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pnpm-workspace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ catalog:
eslint-plugin-import-x: ^4.16.1
eslint-plugin-jsdoc: ^54.1.0
eventemitter3: ^5.0.1
fast-glob: ^3.3.3
happy-dom: ^20.3.4
he: ^1.2.0
lefthook: ^1.11.13
Expand Down
45 changes: 45 additions & 0 deletions skills/superdoc/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: editing-docx
description: Searches, replaces, and reads text in Word documents. Use when the user asks to edit, search, or extract text from .docx files.
---

# SuperDoc CLI

Edit Word documents from the command line. Use instead of python-docx.

## Commands

| Command | Description |
|---------|-------------|
| `npx @superdoc-dev/cli search <pattern> <files...>` | Find text across documents |
| `npx @superdoc-dev/cli replace <find> <to> <files...>` | Find and replace text |
| `npx @superdoc-dev/cli read <file>` | Extract plain text |

## When to Use

Use superdoc when the user asks to:
- Search text in .docx files
- Find and replace text in Word documents
- Extract text content from .docx files
- Bulk edit multiple Word documents

## Examples

```bash
# Search across documents
npx @superdoc-dev/cli search "indemnification" ./contracts/*.docx

# Find and replace
npx @superdoc-dev/cli replace "ACME Corp" "Globex Inc" ./merger/*.docx

# Extract text
npx @superdoc-dev/cli read ./proposal.docx

# JSON output for scripting
npx @superdoc-dev/cli search "Article 7" ./**/*.docx --json
```

## Options

- `--json` — Machine-readable output
- `--help` — Show help
Loading