@superdoc-dev/cli 0.1.0-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +76 -0
- package/dist/index.js +175430 -0
- package/package.json +36 -0
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# @superdoc-dev/cli
|
|
2
|
+
|
|
3
|
+
The command-line interface for [SuperDoc](https://superdoc.dev) — DOCX editing in your terminal.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npx @superdoc-dev/cli search "CONFIDENTIAL" ./legal/*.docx
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Commands
|
|
10
|
+
|
|
11
|
+
| Command | Status | Description |
|
|
12
|
+
|---------|--------|-------------|
|
|
13
|
+
| `search` | Available | Find text across documents |
|
|
14
|
+
| `replace` | Available | Find and replace text |
|
|
15
|
+
| `replace --track` | Coming soon | Replace with track changes |
|
|
16
|
+
| `read` | Available | Extract plain text |
|
|
17
|
+
| `diff` | Coming soon | Compare two documents |
|
|
18
|
+
| `convert` | Coming soon | DOCX ↔ HTML ↔ Markdown |
|
|
19
|
+
| `comments` | Coming soon | List, add, resolve comments |
|
|
20
|
+
| `accept` | Coming soon | Accept/reject track changes |
|
|
21
|
+
|
|
22
|
+
Powered by the SuperDoc document engine. Bulk operations, glob patterns, JSON output.
|
|
23
|
+
|
|
24
|
+
## Install
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm install -g @superdoc-dev/cli
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Or run directly:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npx @superdoc-dev/cli <command>
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Usage
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
# Search across documents
|
|
40
|
+
superdoc search "indemnification" ./contracts/*.docx
|
|
41
|
+
|
|
42
|
+
# Find and replace
|
|
43
|
+
superdoc replace "ACME Corp" "Globex Inc" ./merger/*.docx
|
|
44
|
+
|
|
45
|
+
# Extract text
|
|
46
|
+
superdoc read ./proposal.docx
|
|
47
|
+
|
|
48
|
+
# JSON output for scripting
|
|
49
|
+
superdoc search "Article 7" ./**/*.docx --json
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Options
|
|
53
|
+
|
|
54
|
+
| Flag | Description |
|
|
55
|
+
|------|-------------|
|
|
56
|
+
| `--json` | Machine-readable output |
|
|
57
|
+
| `--help` | Show help |
|
|
58
|
+
|
|
59
|
+
## AI Integration
|
|
60
|
+
|
|
61
|
+
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.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
# Copy skill to Claude Code
|
|
65
|
+
cp -r skills/superdoc ~/.claude/skills/
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
See [`skills/superdoc/SKILL.md`](../../skills/superdoc/SKILL.md) for the skill definition.
|
|
69
|
+
|
|
70
|
+
## Part of SuperDoc
|
|
71
|
+
|
|
72
|
+
This CLI is part of the [SuperDoc](https://github.com/superdoc-dev/superdoc) project — an open source document editor bringing Microsoft Word to the web. Use it alongside the editor, or standalone for document automation.
|
|
73
|
+
|
|
74
|
+
## License
|
|
75
|
+
|
|
76
|
+
AGPL-3.0 · [Enterprise license available](https://superdoc.dev)
|