@polishedapps/doc-splitter 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 PolishedApps LLC and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+# @polishedapps/doc-splitter
+
+`@polishedapps/doc-splitter` is the npm package for the DocSplitter command-line tool. It inspects and splits structured DOCX and PDF documents using their heading hierarchy without modifying the input document.
+
+The package installs the `doc-splitter` command.
+
+The core implementation is bundled into this package. DocSplitter does not
+provide a separate supported public core-library API.
+
+## Requirements
+
+- Node.js 24
+
+## Installation
+
+Install the command globally:
+
+```sh
+npm install --global @polishedapps/doc-splitter
+```
+
+Or run it directly with npm:
+
+```sh
+npx @polishedapps/doc-splitter --help
+```
+
+## Usage
+
+Inspect a document's heading hierarchy:
+
+```sh
+doc-splitter inspect "manual.docx"
+```
+
+Preview the output plan without creating files:
+
+```sh
+doc-splitter plan "manual.docx" --level 2
+```
+
+Split a document:
+
+```sh
+doc-splitter "manual.docx" --output "./output"
+```
+
+Splitting is the default workflow, so there is no `split` command word. DocSplitter previews the planned filenames and asks for confirmation before creating files. Use `--yes` to confirm without prompting.
+
+## Common options
+
+```text
+--level <number>
+--parent-headings <none|filename|folders>
+--index
+--no-index
+--multilevel-index
+--original-name
+--title-case
+--no-title-case
+--json
+--quiet
+```
+
+The split workflow also supports:
+
+```text
+--output <directory>
+--subfolder
+--yes
+```
+
+JSON split execution requires `--yes`:
+
+```sh
+doc-splitter "manual.pdf" --output "./output" --subfolder --json --yes
+```
+
+Run `doc-splitter --help` for the complete command reference.
+
+## Project
+
+- [Source repository](https://github.com/PolishedApps/DocSplitter)
+- [Issue tracker](https://github.com/PolishedApps/DocSplitter/issues)
+- [Security policy](https://github.com/PolishedApps/DocSplitter/security/policy)
+- [MIT License](https://github.com/PolishedApps/DocSplitter/blob/main/LICENSE)

package/bin/doc-splitter.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { runCli } from "../dist/main.js";
+
+await runCli();