|
1 | | -# Rust CLI - Examples |
| 1 | +# Vectorize Iris CLI |
2 | 2 |
|
3 | | -Beautiful command-line tool for extracting text from documents using Vectorize Iris. |
| 3 | +**⚡ Lightning-fast AI document extraction from your terminal** |
4 | 4 |
|
5 | | -## Installation |
| 5 | +A beautiful, cross-platform CLI for extracting text, tables, and structured data from PDFs, images, and documents. Powered by Vectorize Iris AI. |
| 6 | + |
| 7 | +[](https://crates.io/crates/vectorize-iris) |
| 8 | +[](https://opensource.org/licenses/MIT) |
| 9 | + |
| 10 | +## Why Use the CLI? |
| 11 | + |
| 12 | +- 🎨 **Beautiful output** - Color-coded, formatted terminal display |
| 13 | +- ⚡ **Blazing fast** - Native Rust performance |
| 14 | +- 🔧 **Scriptable** - JSON/YAML output for automation |
| 15 | +- 📦 **Zero dependencies** - Single binary, no runtime needed |
| 16 | +- 🌍 **Cross-platform** - Works on Linux, macOS, and Windows |
| 17 | +- 🔌 **Pipeline-ready** - Perfect for shell scripts and CI/CD |
| 18 | + |
| 19 | +## Quick Start |
| 20 | + |
| 21 | +### Installation |
6 | 22 |
|
7 | 23 | ```bash |
8 | | -curl -fsSL https://install.vectorize.io/iris | sh |
| 24 | +curl -fsSL https://raw.githubusercontent.com/vectorize-io/vectorize-iris/refs/heads/main/install.sh | sh |
9 | 25 | ``` |
10 | 26 |
|
11 | | -Or install manually from [releases](https://github.com/vectorize/vectorize-iris/releases). |
| 27 | +**Alternative methods:** |
| 28 | +- Download from [GitHub Releases](https://github.com/vectorize-io/vectorize-iris/releases) |
| 29 | +- Install with `cargo install vectorize-iris` (requires Rust) |
| 30 | + |
| 31 | +### Authentication |
| 32 | + |
| 33 | +Set your credentials (get them at [vectorize.io](https://vectorize.io)): |
12 | 34 |
|
13 | | -Set your credentials: |
14 | 35 | ```bash |
15 | 36 | export VECTORIZE_API_TOKEN="your-token" |
16 | 37 | export VECTORIZE_ORG_ID="your-org-id" |
17 | 38 | ``` |
18 | 39 |
|
19 | | -## Basic Text Extraction |
| 40 | +### Basic Usage |
| 41 | + |
| 42 | +```bash |
| 43 | +vectorize-iris document.pdf |
| 44 | +``` |
| 45 | + |
| 46 | +That's it! Get beautiful, formatted output in your terminal. |
| 47 | + |
| 48 | +## Output Formats |
| 49 | + |
| 50 | +The CLI supports multiple output formats for different use cases: |
| 51 | + |
| 52 | +| Format | Use Case | Command | |
| 53 | +|--------|----------|---------| |
| 54 | +| **Pretty** (default) | Interactive use, beautiful terminal output | `vectorize-iris doc.pdf` | |
| 55 | +| **JSON** | Scripting, piping to `jq` | `vectorize-iris doc.pdf -o json` | |
| 56 | +| **YAML** | Config files, human-readable data | `vectorize-iris doc.pdf -o yaml` | |
| 57 | +| **Text** | Plain text only, no formatting | `vectorize-iris doc.pdf -o text` | |
| 58 | + |
| 59 | +## Examples |
| 60 | + |
| 61 | +### Basic Text Extraction |
20 | 62 |
|
21 | 63 | ```bash |
22 | 64 | vectorize-iris document.pdf |
|
0 commit comments