@markitdownjs/cli 0.1.0 → 0.1.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.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +53 -0
  3. package/package.json +3 -3
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 MarkItDownJS Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,53 @@
1
+ # @markitdownjs/cli
2
+
3
+ [![npm](https://img.shields.io/npm/v/@markitdownjs/cli)](https://www.npmjs.com/package/@markitdownjs/cli)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
6
+ CLI tool for converting documents from the terminal. Part of [MarkItDownJS](https://github.com/markitdownjs/markitdownjs).
7
+
8
+ ## Install
9
+
10
+ ```bash
11
+ npm install -g @markitdownjs/cli
12
+ ```
13
+
14
+ ## Commands
15
+
16
+ ### `convert` — convert a single file
17
+
18
+ ```bash
19
+ markitdownjs convert report.pdf --output report.md
20
+ markitdownjs convert data.json --format markdown
21
+ ```
22
+
23
+ ### `batch` — convert all files in a directory
24
+
25
+ ```bash
26
+ markitdownjs batch ./docs --output ./output --format markdown
27
+ ```
28
+
29
+ ### `serve` — start an HTTP conversion server
30
+
31
+ ```bash
32
+ markitdownjs serve --port 3000
33
+ ```
34
+
35
+ ### `watch` — watch a directory and convert on change
36
+
37
+ ```bash
38
+ markitdownjs watch ./inbox --output ./processed
39
+ ```
40
+
41
+ ## Options
42
+
43
+ | Flag | Description |
44
+ |------|-------------|
45
+ | `--output <path>` | Output file or directory |
46
+ | `--format <fmt>` | Output format: `markdown` (default), `json`, `text` |
47
+ | `--port <n>` | Port for `serve` command (default: `3000`) |
48
+ | `--concurrency <n>` | Parallel workers for `batch` (default: `4`) |
49
+ | `--verbose` | Print per-file progress |
50
+
51
+ ## Part of the MarkItDownJS Monorepo
52
+
53
+ [https://github.com/markitdownjs/markitdownjs](https://github.com/markitdownjs/markitdownjs)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@markitdownjs/cli",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "CLI tool for MarkItDownJS document conversion",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -18,8 +18,8 @@
18
18
  ],
19
19
  "dependencies": {
20
20
  "commander": "^12.0.0",
21
- "@markitdownjs/core": "0.1.0",
22
- "@markitdownjs/shared": "0.1.0"
21
+ "@markitdownjs/core": "0.1.1",
22
+ "@markitdownjs/shared": "0.1.1"
23
23
  },
24
24
  "devDependencies": {
25
25
  "typescript": "^5.5.0",