Skip to content

docs: make the packaged DocStripper quickstart preview-first #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kiku-jw wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: make the packaged DocStripper quickstart preview-first #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 25 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Homebrew Tap for DocStripper

Homebrew tap for [DocStripper](https://github.com/KikuAI-Lab/DocStripper) - AI-powered batch document cleaner.
Homebrew tap for the [DocStripper](https://github.com/KikuAI-Lab/DocStripper)
command-line text cleaner. The CLI uses rule-based cleanup; the optional
browser AI mode is a separate interface in the upstream project.

## Installation

Expand All @@ -9,16 +11,35 @@ brew tap KikuAI-Lab/docstripper
brew install docstripper
```

The [formula](Formula/docstripper.rb) currently installs upstream `v2.1.0`.
Changes on the upstream default branch do not automatically update this tap.

## Usage

Start with existing local files and a non-writing preview:

```bash
docstripper document.txt
docstripper file1.txt file2.docx file3.pdf
docstripper --dry-run document.txt
docstripper --dry-run file1.txt file2.docx file3.pdf
```

> [!WARNING]
> The packaged `v2.1.0` CLI writes cleaned plain text back to the input path
> unless `--dry-run` or `--stdout` is used. This includes DOCX/PDF paths; it
> does not reconstruct those formats. Keep independent originals and do not
> run in-place cleaning on original DOCX/PDF documents.

After reviewing the preview, run in-place cleanup only on a disposable
plain-text copy. `--stdout` avoids modifying the input but also includes
progress and statistics, so it is not a clean machine-readable export.
PDF text extraction needs `pdftotext`; see the upstream supported-format notes.

## Documentation

See the [main repository](https://github.com/KikuAI-Lab/DocStripper) for full documentation.
See the [main repository](https://github.com/KikuAI-Lab/DocStripper) for the
browser application, source, and current CLI documentation. Check the
[packaged v2.1.0 source](https://github.com/KikuAI-Lab/DocStripper/blob/v2.1.0/tool.py)
when behavior differs from the current default branch.

## License

Expand Down