document-cli 1.0.0 → 1.0.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 +29 -0
- package/dist/cli.js +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,6 +6,35 @@
|
|
|
6
6
|
|
|
7
7
|
`document-cli` adds no conversion or editing logic of its own — it is a dispatch layer over `documents.js`'s existing conversion functions, `DocumentConverter` port, live-view editors, and `.odb`/PDF readers. What it adds is two ways to drive them without writing TypeScript: a scriptable, Unix-shaped CLI (stdin/stdout, exit codes, `--json` diagnostics) for pipelines, and a full-screen Ink terminal app for browsing and editing a document interactively.
|
|
8
8
|
|
|
9
|
+
```mermaid
|
|
10
|
+
graph TD
|
|
11
|
+
schema("document-schema.js")
|
|
12
|
+
ooxml("ooxml.js")
|
|
13
|
+
odf("odf.js")
|
|
14
|
+
pdfcodec("pdf-codec")
|
|
15
|
+
documents("documents.js")
|
|
16
|
+
cli("document-cli")
|
|
17
|
+
|
|
18
|
+
schema --> ooxml
|
|
19
|
+
schema --> odf
|
|
20
|
+
schema --> pdfcodec
|
|
21
|
+
schema --> documents
|
|
22
|
+
ooxml --> documents
|
|
23
|
+
odf --> documents
|
|
24
|
+
pdfcodec --> documents
|
|
25
|
+
documents --> cli
|
|
26
|
+
odf --> cli
|
|
27
|
+
|
|
28
|
+
click schema "https://github.com/ExaDev/document-schema.js" "document-schema.js"
|
|
29
|
+
click ooxml "https://github.com/ExaDev/ooxml.js" "ooxml.js"
|
|
30
|
+
click odf "https://github.com/ExaDev/odf.js" "odf.js"
|
|
31
|
+
click pdfcodec "https://github.com/ExaDev/pdf-codec" "pdf-codec"
|
|
32
|
+
click documents "https://github.com/ExaDev/documents.js" "documents.js"
|
|
33
|
+
click cli "https://github.com/ExaDev/document-cli" "document-cli"
|
|
34
|
+
|
|
35
|
+
style cli fill:#f9a825,stroke:#333,stroke-width:3px
|
|
36
|
+
```
|
|
37
|
+
|
|
9
38
|
## Why
|
|
10
39
|
|
|
11
40
|
`documents.js` is a library, not a tool — everything it does happens through function calls from TypeScript/JavaScript. Most people who want to convert a docx to a PDF, extract an `.odb` table to CSV, or poke at a PDF's structure from a terminal don't want to write a script to do it. `document-cli` is that missing entry point: every one of documents.js's 19 direct conversion pairs, its generic converter, its `.odm`/`.odb` extraction functions, and its PDF inspector become a single command-line invocation, and its six live-view editors (docx/pptx/odt/odp/ods/odg) become a keyboard-driven terminal app that never needs a code editor open at all.
|
package/dist/cli.js
CHANGED
package/dist/index.cjs
CHANGED
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "document-cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "CLI and interactive Ink TUI for documents.js: every docx/pptx/odt/odp/ods/odg/odf/odm/odb conversion, bridge, and editor as a scriptable command or a terminal app.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"repository": {
|