{"id":20333097,"url":"https://github.com/jaebradley/flights-search-cli","last_synced_at":"2025-04-11T21:33:08.360Z","repository":{"id":51374506,"uuid":"121802401","full_name":"jaebradley/flights-search-cli","owner":"jaebradley","description":"Search flights from your command line","archived":false,"fork":false,"pushed_at":"2021-05-12T23:07:20.000Z","size":1231,"stargazers_count":20,"open_issues_count":10,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-25T17:46:49.195Z","etag":null,"topics":["airport","command-line-tool","flights","javascript","nodejs","npm-package","search-flights"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/flights-search-cli","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaebradley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-16T21:25:30.000Z","updated_at":"2024-04-05T22:49:25.000Z","dependencies_parsed_at":"2022-09-07T15:40:27.398Z","dependency_job_id":null,"html_url":"https://github.com/jaebradley/flights-search-cli","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaebradley%2Fflights-search-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaebradley%2Fflights-search-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaebradley%2Fflights-search-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaebradley%2Fflights-search-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaebradley","download_url":"https://codeload.github.com/jaebradley/flights-search-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248483367,"owners_count":21111435,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["airport","command-line-tool","flights","javascript","nodejs","npm-package","search-flights"],"created_at":"2024-11-14T20:29:20.525Z","updated_at":"2025-04-11T21:33:08.330Z","avatar_url":"https://github.com/jaebradley.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# flights-search-cli\n\n![Flights Search CLI](https://github.com/jaebradley/flights-search-cli/workflows/Flights%20Search%20CLI/badge.svg)\n[![codecov](https://codecov.io/gh/jaebradley/flights-search-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/jaebradley/flights-search-cli)\n[![npm](https://img.shields.io/npm/v/flights-search-cli.svg)](https://www.npmjs.com/package/flights-search-cli)\n![npm bundle size](https://img.shields.io/bundlephobia/minzip/flights-search-cli)\n[![npm-total-downloads](https://img.shields.io/npm/dt/flights-search-cli.svg)](https://www.npmjs.com/package/flights-search-cli)\n![GitHub](https://img.shields.io/github/license/jaebradley/flights-search-cli)\n\n![alt-text](https://imgur.com/54yeBhy.png)\n![alt-text](https://media.giphy.com/media/1k0AuLZvV7FcMTkDrc/giphy.gif)\n\nSearch flights from the command line!\n\n## Install\n\n```bash\nnpm install flights-search-cli --global\n```\n\n## Usage\n\n1. `flights search` triggers the command line tool\n1. Follow the instructions to\n  * Select what airport you're flying from\n  * Select what airport you're flying to\n  * The departure date range that you're searching over\n  * The departure time of day you're searching over (i.e. \"I only want to look for flights between 3-6 PM\")\n  * Select if you only want to look at round-trip flights\n  * Select maximum total price of flights in USD\n  * Select if you only want to look at direct flights\n1. You'll (hopefully) get a list of flights - after selecting one, you'll be taken to a `kiwi.com` booking page\n\n![kiwi-booking](https://imgur.com/iz4V1oX.png)\n\n### Specifying Command Line Arguments\n\n* Instead of following the prompts every single time, you can also take advantage of the following command line arguments\n* `-s \u003cIATA Airport Code\u003e` or `--start-airport \u003cIATA Airport Code\u003e` sets the departure airport\n  * Like `-s SFO` or `--start-airport SFO`\n* `-e \u003cIATA Airport Code\u003e` or `--end-airport \u003cIATA Airport Code\u003e` sets the arriving airport\n  * `-e SFO` or `--end-airport SFO`\n* `-l \u003cDeparture Window\u003e` or `--leaving-between \u003cDeparture Window\u003e` sets the date(s) or datetime(s) for departure\n  * Like `-l 2019-09-01` or `--leaving-between 2019-09-01`\n  * Can specify a start and an end to a window using the `|` delimiter like (`-l \"2019-09-01|2019-09-07\"`)\n  * 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`\n  * 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`)\n* `-r \u003cDeparture Window\u003e` or `--returning-between \u003cDeparture Window\u003e` works exactly the same as the `--leaving-between` argument, except for return flights\n* `-$ \u003cprice\u003e` or `--max-price \u003cprice\u003e` filters out tickets above a certain price in `USD`\n  * Like `-$ 500` or `--max-price 500`\n* `-d` or `--direct-flight` filters out flights that are _not_ direct\n  * It's a boolean flag, so simply specifying the flag is sufficient - there does not need to be a value associated with the argument\n* `-1` or `--one-way` only calculates flights from the departing airport to the arrival airport\n  * If a returning departure window is specified and this boolean flag is specified, the returning departure window _will_ take precedence\n\n## Development\n\n`flights-search-cli` uses [`nvm`](https://github.com/nvm-sh/nvm) to manage `node` and `npm` versions.\n\nEnsure that you have `nvm` installed, and have the correct `node` version defined in the `.nvmrc` file.\n\nTo build the project locally\n\n1. Execute the `compile` command defined in the `package.json` file\n   * This should execute the Babel transpilation process and output files to the `build` directory\n2. Execute [the `npm link`](https://docs.npmjs.com/cli/link) command\n   * This should symlink the `bin` executable file (`build/executables/flights.js`)\n3. Execute any of the commands (like `flights search`)\n\nAfter 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.\n\n### Git Hooks\n\nThis project uses [`husky`](https://github.com/typicode/husky) to maintain git hooks.\n\n* `pre-commit` - run source code linting and commit message linting\n\n### Commit Linting\n\nThis 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.\n\n## Why `kiwi.com`?\n\nBecause [they provide a pretty simple REST API](https://skypickerpublicapi.docs.apiary.io) to search for flights.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaebradley%2Fflights-search-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaebradley%2Fflights-search-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaebradley%2Fflights-search-cli/lists"}