Skip to content

Commit fdddb08

Browse files
author
Ang
committed
Update README: Add CLI documentation and roadmap
1 parent b7a9b10 commit fdddb08

1 file changed

Lines changed: 94 additions & 2 deletions

File tree

README.md

Lines changed: 94 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,12 +214,104 @@ print('\n\n'.join(result['results']))
214214
```
215215
</details>
216216

217+
## 💻 CLI Commands & Options
217218

219+
OneCite provides a command-line interface with the following commands and options:
220+
221+
### `onecite process`
222+
223+
The main command for processing references through the OneCite pipeline.
224+
225+
**Usage:**
226+
```bash
227+
onecite process <input_file> [OPTIONS]
228+
```
229+
230+
**Arguments:**
231+
- `input_file` - Input file path, `-` for stdin, or a reference string (e.g., DOI, title)
232+
233+
**Options:**
234+
| Option | Short | Description | Default |
235+
|--------|-------|-------------|---------|
236+
| `--input-type` | | Input format: `txt` or `bib` | `txt` |
237+
| `--template` | | Fallback BibTeX entry-type preset when auto-detection is inconclusive | `journal_article_full` |
238+
| `--output-format` | | Output format (currently only `bibtex` supported) | `bibtex` |
239+
| `--output` | `-o` | Output file path (default: stdout) | - |
240+
| `--interactive` | | Enable interactive mode for ambiguous matches | `False` |
241+
| `--quiet` | `-q` | Suppress verbose logging output | `False` |
242+
| `--google-scholar` | | Enable Google Scholar as an additional data source (requires scholarly package) | `False` |
243+
244+
**Examples:**
245+
```bash
246+
# Process a text file
247+
onecite process references.txt -o results.bib
248+
249+
# Process a BibTeX file with auto-detection
250+
onecite process references.bib
251+
252+
# Process with interactive mode
253+
onecite process ambiguous.txt --interactive
254+
255+
# Use stdin
256+
echo "10.1038/nature14539" | onecite process -
257+
258+
# Process a direct string (DOI)
259+
onecite process "10.1038/nature14539"
260+
261+
# Process with custom template
262+
onecite process references.txt --template conference_paper
263+
264+
# Enable Google Scholar (requires scholarly package)
265+
onecite process references.txt --google-scholar
266+
267+
# Quiet mode for scripts
268+
onecite process references.txt -o results.bib --quiet
269+
```
270+
271+
### `onecite --version`
272+
273+
Display the installed OneCite version.
274+
275+
**Usage:**
276+
```bash
277+
onecite --version
278+
```
279+
280+
### `onecite version`
281+
282+
Alternative command to display version information.
283+
284+
**Usage:**
285+
```bash
286+
onecite version
287+
```
288+
289+
### Input Type Auto-Detection
290+
291+
When `--input-type` is not specified, OneCite automatically detects the input type:
292+
- Files ending with `.bib` are treated as BibTeX format
293+
- All other files and strings are treated as plain text
294+
295+
### Available Templates
296+
297+
OneCite supports several template presets for different entry types:
298+
- `journal_article_full` - Full journal article entry (default)
299+
- `conference_paper` - Conference proceedings paper
300+
- `book` - Book entry
301+
- `thesis` - Thesis/dissertation entry
302+
- `dataset` - Dataset entry
303+
- `software` - Software/code entry
304+
305+
### Exit Codes
306+
307+
- `0` - Success
308+
- `1` - Error occurred (invalid input, processing failure, etc.)
218309

219310
## 🗺️ Roadmap
220311

221-
- **OneCite Skill** — Skill package for AI coding agents (Claude Code, Windsurf, etc.).
222-
- **Benchmarking** — Public benchmark suite and leaderboard for citation extraction/verification accuracy.
312+
- **OneCite Skill** — Skill package for AI coding agents
313+
- **Benchmarking** — Public benchmark suite and leaderboard
314+
- **Enhanced CLI** — Additional CLI commands
223315

224316
## 🤝 Contributing
225317

0 commit comments

Comments
 (0)