Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Getting Started

Install Crosswind and run your first flight search in under a minute.

1. Install Crosswind

# One-command install (recommended)
curl -fsSL https://raw.githubusercontent.com/dzmbs/crosswind/main/install.sh | bash
 
# Or install with cargo
cargo install --git https://github.com/dzmbs/crosswind --bin crosswind

Confirm it works:

crosswind --version
crosswind --help

See Installation for other methods and platform details.

2. Search for flights

# One-way: Belgrade to New York, April 1st
crosswind BEG JFK apr1
 
# Round-trip with return date
crosswind BEG JFK apr1 -r apr16

Crosswind uses 3-letter IATA airport codes. The date accepts many formats: apr1, 4/1, +7, tomorrow, or 2026-04-01.

3. Filter results

# Nonstop flights only
crosswind LAX JFK apr1 --max-stops 0
 
# Business class, 2 passengers
crosswind BEG LHR apr1 -c business -p 2
 
# Prices in EUR
crosswind BEG CDG apr1 --currency EUR

4. Get JSON output

When piped, Crosswind automatically outputs JSON. Force it in a terminal with --json:

# Auto JSON when piped
crosswind BEG JFK apr1 | jq '.data.flights[0]'
 
# Force JSON in terminal
crosswind BEG JFK apr1 --json

The JSON envelope follows a consistent structure:

{
  "v": 1,
  "status": "ok",
  "cmd": "search",
  "data": { "flights": [...], "airlines": [...] },
  "timing_ms": 1423
}

5. Compare destinations

Search multiple destinations in one command:

crosswind BEG JFK,LHR,CDG apr1

Results are merged and sorted by price.

6. Open in browser

Preview the search on Google Flights directly:

crosswind BEG JFK apr1 --open

Next steps