Skip to content

Commit b0a5b7b

Browse files
docs: add Homebrew installation instructions (#8)
- Add 'brew tap raphaelmansuy/tap && brew install edgeparse' as the recommended installation method in quick-start-cli.mdx (ahead of cargo and pre-built binary options) - Add 'Brew' tab to the QuickStart component on the landing page - Update CLI tab on landing page to include brew as primary install path - Verified formula live at raphaelmansuy/homebrew-tap
1 parent de8e694 commit b0a5b7b

2 files changed

Lines changed: 45 additions & 3 deletions

File tree

site/src/content/docs/getting-started/quick-start-cli.mdx

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,39 @@
11
---
22
title: "Quick Start: CLI"
3-
description: "Extract PDFs from the command line with edgeparse-cli."
3+
description: "Extract PDFs from the command line with edgeparse-cli. Install via Homebrew, cargo, or pre-built binary."
44
---
55

66
## Installation
77

8+
### Homebrew (macOS / Linux) — Recommended
9+
10+
```bash
11+
brew tap raphaelmansuy/tap
12+
brew install edgeparse
13+
```
14+
15+
Verify:
16+
17+
```bash
18+
edgeparse --version
19+
```
20+
21+
### cargo (any platform)
22+
823
```bash
924
cargo install edgeparse-cli
1025
```
1126

12-
Or download a pre-built binary from [GitHub Releases](https://github.com/raphaelmansuy/edgeparse/releases).
27+
### Pre-built binary
28+
29+
Download a platform binary from [GitHub Releases](https://github.com/raphaelmansuy/edgeparse/releases), make it executable, and add it to your `PATH`:
30+
31+
```bash
32+
# macOS arm64 example
33+
curl -L https://github.com/raphaelmansuy/edgeparse/releases/latest/download/edgeparse-aarch64-apple-darwin.tar.gz | tar xz
34+
chmod +x edgeparse
35+
sudo mv edgeparse /usr/local/bin/
36+
```
1337

1438
## Basic Usage
1539

site/src/content/docs/index.mdx

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,21 @@ npx skills add raphaelmansuy/edgeparse --skill edgeparse
4141
4242
# Step 2: Install the Python runtime
4343
pip install edgeparse` },
44+
{ label: 'Brew', lang: 'bash', code: `# macOS / Linux — one-time setup
45+
brew tap raphaelmansuy/tap
46+
brew install edgeparse
47+
48+
# Verify installation
49+
edgeparse --version
50+
51+
# Parse a PDF to Markdown
52+
edgeparse report.pdf --format markdown
53+
54+
# Parse to JSON with bounding boxes
55+
edgeparse invoice.pdf --format json
56+
57+
# Batch convert a directory
58+
edgeparse docs/*.pdf --format markdown --output-dir results/` },
4459
{ label: 'Python', lang: 'python', code: `import edgeparse, json
4560
4661
# Convert PDF to Markdown
@@ -72,7 +87,10 @@ const pages = convert("report.pdf", { format: "markdown", pages: "1-5" });
7287
7388
// Save to output directory
7489
const path = convertFile("report.pdf", { outputDir: "out/", format: "markdown" });` },
75-
{ label: 'CLI', lang: 'bash', code: `# Install
90+
{ label: 'CLI', lang: 'bash', code: `# Install via Homebrew (macOS / Linux)
91+
brew tap raphaelmansuy/tap && brew install edgeparse
92+
93+
# Or via pip
7694
pip install edgeparse
7795
7896
# Extract PDF to Markdown

0 commit comments

Comments
 (0)