https://github.com/jaebradley/flights-search-cli

Search flights from your command line
https://github.com/jaebradley/flights-search-cli

airport command-line-tool flights javascript nodejs npm-package search-flights

Last synced: 6 months ago
JSON representation

Search flights from your command line

• Host: GitHub
• URL: https://github.com/jaebradley/flights-search-cli
• Owner: jaebradley
• License: mit
• Created: 2018-02-16T21:25:30.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-05-12T23:07:20.000Z (over 4 years ago)
• Last Synced: 2025-03-25T17:46:49.195Z (7 months ago)
• Topics: airport, command-line-tool, flights, javascript, nodejs, npm-package, search-flights
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/flights-search-cli
• Size: 1.17 MB
• Stars: 20
• Watchers: 3
• Forks: 3
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# flights-search-cli

![Flights Search CLI](https://github.com/jaebradley/flights-search-cli/workflows/Flights%20Search%20CLI/badge.svg)

[![codecov](https://codecov.io/gh/jaebradley/flights-search-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/jaebradley/flights-search-cli)

[![npm](https://img.shields.io/npm/v/flights-search-cli.svg)](https://www.npmjs.com/package/flights-search-cli)

![npm bundle size](https://img.shields.io/bundlephobia/minzip/flights-search-cli)

[![npm-total-downloads](https://img.shields.io/npm/dt/flights-search-cli.svg)](https://www.npmjs.com/package/flights-search-cli)

![GitHub](https://img.shields.io/github/license/jaebradley/flights-search-cli)

![alt-text](https://imgur.com/54yeBhy.png)

![alt-text](https://media.giphy.com/media/1k0AuLZvV7FcMTkDrc/giphy.gif)

Search flights from the command line!

## Install

```bash

npm install flights-search-cli --global

```

## Usage

1. `flights search` triggers the command line tool

1. Follow the instructions to

  * Select what airport you're flying from

  * Select what airport you're flying to

  * The departure date range that you're searching over

  * The departure time of day you're searching over (i.e. "I only want to look for flights between 3-6 PM")

  * Select if you only want to look at round-trip flights

  * Select maximum total price of flights in USD

  * Select if you only want to look at direct flights

1. You'll (hopefully) get a list of flights - after selecting one, you'll be taken to a `kiwi.com` booking page

![kiwi-booking](https://imgur.com/iz4V1oX.png)

### Specifying Command Line Arguments

* Instead of following the prompts every single time, you can also take advantage of the following command line arguments

* `-s ` or `--start-airport ` sets the departure airport

  * Like `-s SFO` or `--start-airport SFO`

* `-e ` or `--end-airport ` sets the arriving airport

  * `-e SFO` or `--end-airport SFO`

* `-l ` or `--leaving-between ` sets the date(s) or datetime(s) for departure

  * Like `-l 2019-09-01` or `--leaving-between 2019-09-01`

  * Can specify a start and an end to a window using the `|` delimiter like (`-l "2019-09-01|2019-09-07"`)

  * Can also specify a datetime window like `-l "2019-09-01T11:30|2019-09-07T14:30"` which would look at all departure times between `11:30 AM` on `2019-09-01` to `2:30 PM` on `2019-09-07`

  * Dates need to follow [the HTML5 date format](https://momentjs.com/docs/#/parsing/special-formats/) (`YYYY-MM-DD`) and datetimes need to follow the HTML5 datetime format (`YYYY-MM-DDTHH:mm`)

* `-r ` or `--returning-between ` works exactly the same as the `--leaving-between` argument, except for return flights

* `-$ ` or `--max-price ` filters out tickets above a certain price in `USD`

  * Like `-$ 500` or `--max-price 500`

* `-d` or `--direct-flight` filters out flights that are _not_ direct

  * It's a boolean flag, so simply specifying the flag is sufficient - there does not need to be a value associated with the argument

* `-1` or `--one-way` only calculates flights from the departing airport to the arrival airport

  * If a returning departure window is specified and this boolean flag is specified, the returning departure window _will_ take precedence

## Development

`flights-search-cli` uses [`nvm`](https://github.com/nvm-sh/nvm) to manage `node` and `npm` versions.

Ensure that you have `nvm` installed, and have the correct `node` version defined in the `.nvmrc` file.

To build the project locally

1. Execute the `compile` command defined in the `package.json` file

   * This should execute the Babel transpilation process and output files to the `build` directory

2. Execute [the `npm link`](https://docs.npmjs.com/cli/link) command

   * This should symlink the `bin` executable file (`build/executables/flights.js`)

3. Execute any of the commands (like `flights search`)

After making changes to the source code, you will need to rebuild the project and re-link the updated `build` files in order to test any changes you've made to the source code.

### Git Hooks

This project uses [`husky`](https://github.com/typicode/husky) to maintain git hooks.

* `pre-commit` - run source code linting and commit message linting

### Commit Linting

This project uses [`semantic-release`](https://github.com/semantic-release/semantic-release) and [`commitlint`](https://github.com/conventional-changelog/commitlint) (specifically the [Angular commit convention](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)) to automatically enforce semantic versioning.

## Why `kiwi.com`?

Because [they provide a pretty simple REST API](https://skypickerpublicapi.docs.apiary.io) to search for flights.