--8<-- [start:fr24]
$ fr24 --help

Usage: fr24 [OPTIONS] COMMAND [ARGS]...

Options:
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.
  --help                Show this message and exit.

Commands:
  dirs                 Shows relevant directories
  tui                  Starts the TUI
  flight-list          Fetch the flight list.
  flight-list-all      Fetch all pages of the flight list.
  playback             Fetch the playback data for a flight.
  live-feed            Fetch the live feed.
  live-feed-playback   Fetch a playback of the live feed.
  nearest-flights      Fetch the nearest flights.
  live-flights-status  Fetch the live flights status.
  flight-details       Fetch flight details.
  top-flights          Fetch the top flights.
  playback-flight      Fetch playback flight details.
  auth                 Commands for authentication
--8<-- [end:fr24]
--8<-- [start:fr24_dirs]
$ fr24 dirs --help

Usage: fr24 [OPTIONS]

  Shows relevant directories

Options:
  --help  Show this message and exit.
--8<-- [end:fr24_dirs]
--8<-- [start:fr24_tui]
$ fr24 tui --help

Usage: fr24 [OPTIONS]

  Starts the TUI

Options:
  --help  Show this message and exit.
--8<-- [end:fr24_tui]
--8<-- [start:fr24_flight-list]
$ fr24 flight-list --help

Usage: fr24 [OPTIONS]

  Fetch the flight list.

Options:
  --reg TEXT                      Aircraft registration (e.g. `B-HUJ`)
  --flight TEXT                   Flight number (e.g. `CX8747`)
  --page INTEGER                  Page number  [default: 1]
  --limit INTEGER                 Number of results per page - use `100` if
                                  authenticated.  [default: 10]
  --timestamp TIMESTAMP_S         Show flights with ATD before this Unix
                                  timestamp  [default: now]
  --filter-by [historic]          If `historic`, do not return scheduled or
                                  live flights
  -o, --output FILEPATH|CACHE|-   Save results to a specific filepath. If `-`,
                                  results will be printed to stdout. If
                                  `cache`, results will be saved to the
                                  default cache.  [default:
                                  flight_list.parquet]
  -f, --format [parquet|csv]      Output format  [default: parquet]
  --when-file-exists [backup|error|overwrite]
                                  Action when output file path already exists.
                                  [default: backup]
  --help                          Show this message and exit.
--8<-- [end:fr24_flight-list]
--8<-- [start:fr24_flight-list-all]
$ fr24 flight-list-all --help

Usage: fr24 [OPTIONS]

  Fetch all pages of the flight list.

Options:
  --reg TEXT                      Aircraft registration (e.g. `B-HUJ`)
  --flight TEXT                   Flight number (e.g. `CX8747`)
  --page INTEGER                  Page number  [default: 1]
  --limit INTEGER                 Number of results per page - use `100` if
                                  authenticated.  [default: 10]
  --timestamp TIMESTAMP_S         Show flights with ATD before this Unix
                                  timestamp  [default: now]
  --filter-by [historic]          If `historic`, do not return scheduled or
                                  live flights
  --delay INTEGER                 Delay between requests in seconds.
                                  [default: 5]
  --max-pages INTEGER             Maximum number of pages to fetch.
  -o, --output FILEPATH|CACHE|-   Save results to a specific filepath. If `-`,
                                  results will be printed to stdout. If
                                  `cache`, results will be saved to the
                                  default cache.  [default:
                                  flight_list_all.parquet]
  -f, --format [parquet|csv]      Output format  [default: parquet]
  --when-file-exists [backup|error|overwrite]
                                  Action when output file path already exists.
                                  [default: backup]
  --help                          Show this message and exit.
--8<-- [end:fr24_flight-list-all]
--8<-- [start:fr24_playback]
$ fr24 playback --help

Usage: fr24 [OPTIONS]

  Fetch the playback data for a flight.

Options:
  --flight-id FLIGHT_ID           fr24 flight id, represented in hex
                                  [required]
  --timestamp TIMESTAMP_S         Actual time of departure (ATD) of the
                                  historic flight, Unix timestamp in seconds.
                                  Optional, but it is recommended to include
                                  it.
  -o, --output FILEPATH|CACHE|-   Save results to a specific filepath. If `-`,
                                  results will be printed to stdout. If
                                  `cache`, results will be saved to the
                                  default cache.  [default: playback.parquet]
  -f, --format [parquet|csv]      Output format  [default: parquet]
  --when-file-exists [backup|error|overwrite]
                                  Action when output file path already exists.
                                  [default: backup]
  --help                          Show this message and exit.
--8<-- [end:fr24_playback]
--8<-- [start:fr24_live-feed]
$ fr24 live-feed --help

Usage: fr24 [OPTIONS]

  Fetch the live feed.

Options:
  --bounding-box SOUTH,NORTH,WEST,EAST
                                  Example (france UIR): `42.0, 52.0, -8.0,
                                  10.0`  [required]
  --stats / --no-stats            Whether to include stats in the given area.
                                  [default: no-stats]
  --limit INTEGER                 Maximum number of flights (should be set to
                                  1500 for unauthorized users, 2000 for
                                  authorized users).  [default: 1500]
  --maxage INTEGER                Maximum time since last message update,
                                  seconds.  [default: 14400]
  --fields [flight|reg|route|type|squawk|vspeed|airspace|logo_id|age]
                                  Fields to include. For unauthenticated
                                  users, a maximum of 4 fields can be
                                  included. When authenticated, `squawk`,
                                  `vspeed`, `airspace`, `logo_id` and `age`
                                  can be included.  [default: {'reg',
                                  'flight', 'route', 'type'}]
  -o, --output FILEPATH|CACHE|-   Save results to a specific filepath. If `-`,
                                  results will be printed to stdout. If
                                  `cache`, results will be saved to the
                                  default cache.  [default:
                                  live_feed.parquet]
  -f, --format [parquet|csv]      Output format  [default: parquet]
  --when-file-exists [backup|error|overwrite]
                                  Action when output file path already exists.
                                  [default: backup]
  --help                          Show this message and exit.
--8<-- [end:fr24_live-feed]
--8<-- [start:fr24_live-feed-playback]
$ fr24 live-feed-playback --help

Usage: fr24 [OPTIONS]

  Fetch a playback of the live feed.

Options:
  --bounding-box SOUTH,NORTH,WEST,EAST
                                  Example (france UIR): `42.0, 52.0, -8.0,
                                  10.0`  [required]
  --stats / --no-stats            Whether to include stats in the given area.
                                  [default: no-stats]
  --limit INTEGER                 Maximum number of flights (should be set to
                                  1500 for unauthorized users, 2000 for
                                  authorized users).  [default: 1500]
  --maxage INTEGER                Maximum time since last message update,
                                  seconds.  [default: 14400]
  --fields [flight|reg|route|type|squawk|vspeed|airspace|logo_id|age]
                                  Fields to include. For unauthenticated
                                  users, a maximum of 4 fields can be
                                  included. When authenticated, `squawk`,
                                  `vspeed`, `airspace`, `logo_id` and `age`
                                  can be included.  [default: {'reg',
                                  'flight', 'route', 'type'}]
  --timestamp TIMESTAMP_S         Start timestamp  [default: now]
  --duration INTEGER              Duration of prefetch,
                                  `floor(7.5*(multiplier))` seconds  For 1x
                                  playback, this should be 7 seconds.
                                  [default: 7]
  --hfreq INTEGER                 High frequency mode
  -o, --output FILEPATH|CACHE|-   Save results to a specific filepath. If `-`,
                                  results will be printed to stdout. If
                                  `cache`, results will be saved to the
                                  default cache.  [default:
                                  live_feed_playback.parquet]
  -f, --format [parquet|csv]      Output format  [default: parquet]
  --when-file-exists [backup|error|overwrite]
                                  Action when output file path already exists.
                                  [default: backup]
  --help                          Show this message and exit.
--8<-- [end:fr24_live-feed-playback]
--8<-- [start:fr24_nearest-flights]
$ fr24 nearest-flights --help

Usage: fr24 [OPTIONS]

  Fetch the nearest flights.

Options:
  --lat FLOAT                     Latitude, degrees, -90 to 90  [required]
  --lon FLOAT                     Longitude, degrees, -180 to 180  [required]
  --radius INTEGER                Radius, metres  [default: 10000]
  --limit INTEGER                 Maximum number of aircraft to return
                                  [default: 1500]
  -o, --output FILEPATH|CACHE|-   Save results to a specific filepath. If `-`,
                                  results will be printed to stdout. If
                                  `cache`, results will be saved to the
                                  default cache.  [default:
                                  nearest_flights.parquet]
  -f, --format [parquet|csv]      Output format  [default: parquet]
  --when-file-exists [backup|error|overwrite]
                                  Action when output file path already exists.
                                  [default: backup]
  --help                          Show this message and exit.
--8<-- [end:fr24_nearest-flights]
--8<-- [start:fr24_live-flights-status]
$ fr24 live-flights-status --help

Usage: fr24 [OPTIONS]

  Fetch the live flights status.

Options:
  --flight-ids FLIGHT_ID          List of flight IDs to get status for
                                  [required]
  -o, --output FILEPATH|CACHE|-   Save results to a specific filepath. If `-`,
                                  results will be printed to stdout. If
                                  `cache`, results will be saved to the
                                  default cache.  [default:
                                  live_flights_status.parquet]
  -f, --format [parquet|csv]      Output format  [default: parquet]
  --when-file-exists [backup|error|overwrite]
                                  Action when output file path already exists.
                                  [default: backup]
  --help                          Show this message and exit.
--8<-- [end:fr24_live-flights-status]
--8<-- [start:fr24_flight-details]
$ fr24 flight-details --help

Usage: fr24 [OPTIONS]

  Fetch flight details.

Options:
  --flight-id FLIGHT_ID           Flight ID to fetch details for. Must be
                                  live, or the response will contain an empty
                                  `DATA` frame error.  [required]
  --restriction-mode FLIGHT_ID    [FAA LADD](https://www.faa.gov/pilots/ladd)
                                  visibility mode.  [default: 0]
  --verbose / --no-verbose        Whether to include [fr24.proto.v1_pb2.Flight
                                  DetailsResponse.flight_plan] and [fr24.proto
                                  .v1_pb2.FlightDetailsResponse.aircraft_detai
                                  ls] in the response.  [default: verbose]
  -o, --output FILEPATH|CACHE|-   Save results to a specific filepath. If `-`,
                                  results will be printed to stdout. If
                                  `cache`, results will be saved to the
                                  default cache.  [default:
                                  flight_details.parquet]
  -f, --format [parquet|csv]      Output format  [default: parquet]
  --when-file-exists [backup|error|overwrite]
                                  Action when output file path already exists.
                                  [default: backup]
  --help                          Show this message and exit.
--8<-- [end:fr24_flight-details]
--8<-- [start:fr24_top-flights]
$ fr24 top-flights --help

Usage: fr24 [OPTIONS]

  Fetch the top flights.

Options:
  --limit INTEGER                 Maximum number of top flights to return
                                  (1-10)  [default: 10]
  -o, --output FILEPATH|CACHE|-   Save results to a specific filepath. If `-`,
                                  results will be printed to stdout. If
                                  `cache`, results will be saved to the
                                  default cache.  [default:
                                  top_flights.parquet]
  -f, --format [parquet|csv]      Output format  [default: parquet]
  --when-file-exists [backup|error|overwrite]
                                  Action when output file path already exists.
                                  [default: backup]
  --help                          Show this message and exit.
--8<-- [end:fr24_top-flights]
--8<-- [start:fr24_playback-flight]
$ fr24 playback-flight --help

Usage: fr24 [OPTIONS]

  Fetch playback flight details.

Options:
  --flight-id FLIGHT_ID           Flight ID to fetch details for. Must not be
                                  live, or the response will contain an empty
                                  `DATA` frame error.  [required]
  --timestamp TIMESTAMP_S         Actual time of departure (ATD) of the
                                  historic flight  [required]
  -o, --output FILEPATH|CACHE|-   Save results to a specific filepath. If `-`,
                                  results will be printed to stdout. If
                                  `cache`, results will be saved to the
                                  default cache.  [default:
                                  playback_flight.parquet]
  -f, --format [parquet|csv]      Output format  [default: parquet]
  --when-file-exists [backup|error|overwrite]
                                  Action when output file path already exists.
                                  [default: backup]
  --help                          Show this message and exit.
--8<-- [end:fr24_playback-flight]
--8<-- [start:fr24_auth]
$ fr24 auth --help

Usage: fr24 [OPTIONS] COMMAND [ARGS]...

  Commands for authentication

Options:
  --help  Show this message and exit.

Commands:
  show    Shows authentication status
  create  Create a template config file in the user config directory
--8<-- [end:fr24_auth]
--8<-- [start:fr24_auth_show]
$ fr24 auth show --help

Usage: fr24 [OPTIONS]

  Shows authentication status

Options:
  --help  Show this message and exit.
--8<-- [end:fr24_auth_show]
--8<-- [start:fr24_auth_create]
$ fr24 auth create --help

Usage: fr24 [OPTIONS]

  Create a template config file in the user config directory

Options:
  --force / --no-force  Overwrite existing configuration file  [default: no-
                        force]
  --help                Show this message and exit.
--8<-- [end:fr24_auth_create]
