Files
paracas/bin/README.md
T

108 lines
1.7 KiB
Markdown
Raw Normal View History

2025-12-29 17:05:07 -05:00
# paracas
2025-12-29 13:21:48 -05:00
Command-line interface for downloading Dukascopy tick data.
## Installation
```bash
2025-12-29 17:05:07 -05:00
cargo install paracas
2025-12-29 13:21:48 -05:00
```
## Commands
### Download
Download tick data for an instrument:
```bash
# Download EUR/USD ticks as CSV
2025-12-29 17:05:07 -05:00
paracas download eurusd -s 2024-01-01 -e 2024-01-31 -o data.csv
2025-12-29 13:21:48 -05:00
# Download as Parquet with 1-hour aggregation
2025-12-29 17:05:07 -05:00
paracas download btcusd -s 2024-01-01 -e 2024-12-31 -o data.parquet -f parquet -t h1
# Download in background
paracas download eurusd -s 2024-01-01 -e 2024-12-31 --background
```
### Download All
Download all instruments (or filter by category):
```bash
# Download all forex instruments
paracas download-all --category forex -o ./data/
# Download all crypto as Parquet in background
paracas download-all --category crypto -f parquet --background
2025-12-29 13:21:48 -05:00
```
### List
List available instruments:
```bash
# List all instruments
paracas list
# Filter by category
paracas list --category forex
# Search
paracas list --search btc
```
### Info
Show instrument details:
```bash
paracas info eurusd
```
### Status
Check background job status:
```bash
# Show all jobs
paracas status --all
# Show only running jobs
paracas status --running
# Check specific job
paracas status <job-id>
# Watch mode (refresh every 5 seconds)
paracas status --follow 5
# Cancel a running job
paracas status --cancel <job-id>
```
### Job
Manage background jobs:
```bash
# Pause a running job
paracas job pause <job-id>
# Resume a paused job
paracas job resume <job-id>
# Kill a running or paused job
paracas job kill <job-id>
# Clean up finished jobs
paracas job clean
# Clean all finished jobs
paracas job clean --all
```
2025-12-29 13:21:48 -05:00
## License
MIT License - see [LICENSE](../LICENSE) for details.