Initial commit
This commit is contained in:
61
commands/help.md
Normal file
61
commands/help.md
Normal file
@@ -0,0 +1,61 @@
|
||||
---
|
||||
description: Show help information for ollama-deepseek-ocr-tool
|
||||
argument-hint: none
|
||||
---
|
||||
|
||||
Display help information for ollama-deepseek-ocr-tool, a CLI tool for batch OCR processing
|
||||
using DeepSeek-OCR via Ollama. Converts image sequences to markdown documents.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Show full help with examples and troubleshooting
|
||||
ollama-deepseek-ocr-tool --help
|
||||
|
||||
# Show version
|
||||
ollama-deepseek-ocr-tool --version
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
- `--help` / `-h`: Show help with examples, prerequisites, and troubleshooting
|
||||
- `--version`: Show version number
|
||||
- `-v`, `-vv`, `-vvv`: Verbosity levels (INFO, DEBUG, TRACE)
|
||||
|
||||
## Examples
|
||||
|
||||
```bash
|
||||
# Get help (shows progressive examples)
|
||||
ollama-deepseek-ocr-tool --help
|
||||
|
||||
# Check version
|
||||
ollama-deepseek-ocr-tool --version
|
||||
|
||||
# Basic usage (from help)
|
||||
ollama-deepseek-ocr-tool "*.png" output.md
|
||||
|
||||
# With verbose logging
|
||||
ollama-deepseek-ocr-tool "*.png" output.md -vv
|
||||
```
|
||||
|
||||
## What Help Shows
|
||||
|
||||
The `--help` output includes:
|
||||
- **Description**: What the tool does
|
||||
- **Arguments**: GLOB_PATTERN and OUTPUT_FILE
|
||||
- **Examples**: Progressive from simple to complex
|
||||
- **Output Format**: How the markdown is structured
|
||||
- **Prerequisites**: Ollama setup steps
|
||||
- **Troubleshooting**: Common errors and solutions
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# 1. Install prerequisites
|
||||
brew install ollama
|
||||
ollama serve
|
||||
ollama pull deepseek-ocr
|
||||
|
||||
# 2. Process images
|
||||
ollama-deepseek-ocr-tool "IMG_*.png" chapter.md
|
||||
```
|
||||
Reference in New Issue
Block a user