# Koleo CLI
[](https://pypi.org/project/koleo-cli)
[](https://pypi.org/project/koleo-cli)
## Installation
**install via pip by running** `pip install koleo-cli`
## it currently allows you to:
- get departures/arrival list for a station
- get train info given its number and name(pull requests are welcome if you know how to get a train object by just the number)
- find a station or list all known stations
- find a connection from station a to b, with filtering by operators
- save a station as your favourite to quickly check it's departures
- add station aliases to query them more easily
- check seat allocation statistics
### coming soon™️:
- TUI ticket purchase interface
- ticket display
- your previous tickets + stats
- find empty compartments
additionally you can also use the KoleoAPI wrapper directly in your own projects, all returns are fully typed using `typing.TypedDict`
## MY(possibly controversial) design choices:
- platforms and track numbers are shown using arabic numerals instead of roman
- you can change it by adding `use_roman_numerals: true` to your `koleo-cli.json` config file
- most api queries are cached for 24h
- you can change it by adding `disable_cache: true` to your `koleo-cli.json` config file
- stations/ls uses emojis by default
- you can disable them by adding `use_country_flags_emoji: false` and `use_country_flags_emoji: false` to your `koleo-cli.json` config file
pull requests are welcome!!
```
usage: koleo [-h] [-c CONFIG] [--nocolor]
{departures,d,dep,odjazdy,o,arrivals,a,arr,przyjazdy,p,all,w,wszystkie,all_trains,pociagi,trainroute,r,tr,t,poc,pociąg,traincalendar,kursowanie,tc,k,traindetail,td,tid,id,idpoc,stations,s,find,f,stacje,ls,q,connections,do,z,szukaj,path,trainstats,ts,tp,miejsca,frekwencja,trainconnectionstats,tcs,aliases} ...
Koleo CLI
options:
-h, --help show this help message and exit
-c, --config CONFIG Custom config path.
--nocolor Disable color output and formatting
actions:
{departures,d,dep,odjazdy,o,arrivals,a,arr,przyjazdy,p,all,w,wszystkie,all_trains,pociagi,trainroute,r,tr,t,poc,pociąg,traincalendar,kursowanie,tc,k,traindetail,td,tid,id,idpoc,stations,s,find,f,stacje,ls,q,connections,do,z,szukaj,path,trainstats,ts,tp,miejsca,frekwencja,trainconnectionstats,tcs,aliases}
departures (d, dep, odjazdy, o)
Allows you to list station departures
arrivals (a, arr, przyjazdy, p)
Allows you to list station departures
all (w, wszystkie, all_trains, pociagi)
Allows you to list all station trains
trainroute (r, tr, t, poc, pociąg)
Allows you to check the train's route
traincalendar (kursowanie, tc, k)
Allows you to check what days the train runs on
traindetail (td, tid, id, idpoc)
Allows you to show the train's route given it's koleo ID
stations (s, find, f, stacje, ls, q)
Allows you to find stations by their name
connections (do, z, szukaj, path)
Allows you to search for connections from a to b
trainstats (ts, tp, miejsca, frekwencja)
Allows you to check seat allocation info for a train.
trainconnectionstats (tcs)
Allows you to check the seat allocations on the train connection given it's koleo ID
aliases Save quick aliases for station names!
```
Raw data
{
"_id": null,
"home_page": "https://github.com/lzgirlcat/koleo-cli",
"name": "koleo-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "cb98uzhd@duck.com",
"keywords": "koleo, timetable, trains, rail, poland",
"author": "Zoey !",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d4/a9/e86c9ef8d1060a6c2921de127e01e5ebaa4cdf2c64ea6080be67850e2f39/koleo_cli-0.2.137.22.tar.gz",
"platform": null,
"description": "# Koleo CLI\n[](https://pypi.org/project/koleo-cli)\n[](https://pypi.org/project/koleo-cli)\n\n## Installation\n**install via pip by running** `pip install koleo-cli`\n\n\n\n\n## it currently allows you to:\n - get departures/arrival list for a station\n - get train info given its number and name(pull requests are welcome if you know how to get a train object by just the number)\n - find a station or list all known stations\n - find a connection from station a to b, with filtering by operators\n - save a station as your favourite to quickly check it's departures\n - add station aliases to query them more easily\n - check seat allocation statistics\n\n### coming soon\u2122\ufe0f:\n - TUI ticket purchase interface\n - ticket display\n - your previous tickets + stats\n - find empty compartments \nadditionally you can also use the KoleoAPI wrapper directly in your own projects, all returns are fully typed using `typing.TypedDict`\n\n## MY(possibly controversial) design choices:\n - platforms and track numbers are shown using arabic numerals instead of roman\n - you can change it by adding `use_roman_numerals: true` to your `koleo-cli.json` config file\n - most api queries are cached for 24h\n - you can change it by adding `disable_cache: true` to your `koleo-cli.json` config file\n - stations/ls uses emojis by default\n - you can disable them by adding `use_country_flags_emoji: false` and `use_country_flags_emoji: false` to your `koleo-cli.json` config file\npull requests are welcome!!\n\n```\nusage: koleo [-h] [-c CONFIG] [--nocolor]\n {departures,d,dep,odjazdy,o,arrivals,a,arr,przyjazdy,p,all,w,wszystkie,all_trains,pociagi,trainroute,r,tr,t,poc,poci\u0105g,traincalendar,kursowanie,tc,k,traindetail,td,tid,id,idpoc,stations,s,find,f,stacje,ls,q,connections,do,z,szukaj,path,trainstats,ts,tp,miejsca,frekwencja,trainconnectionstats,tcs,aliases} ...\n\nKoleo CLI\n\noptions:\n -h, --help show this help message and exit\n -c, --config CONFIG Custom config path.\n --nocolor Disable color output and formatting\n\nactions:\n {departures,d,dep,odjazdy,o,arrivals,a,arr,przyjazdy,p,all,w,wszystkie,all_trains,pociagi,trainroute,r,tr,t,poc,poci\u0105g,traincalendar,kursowanie,tc,k,traindetail,td,tid,id,idpoc,stations,s,find,f,stacje,ls,q,connections,do,z,szukaj,path,trainstats,ts,tp,miejsca,frekwencja,trainconnectionstats,tcs,aliases}\n departures (d, dep, odjazdy, o)\n Allows you to list station departures\n arrivals (a, arr, przyjazdy, p)\n Allows you to list station departures\n all (w, wszystkie, all_trains, pociagi)\n Allows you to list all station trains\n trainroute (r, tr, t, poc, poci\u0105g)\n Allows you to check the train's route\n traincalendar (kursowanie, tc, k)\n Allows you to check what days the train runs on\n traindetail (td, tid, id, idpoc)\n Allows you to show the train's route given it's koleo ID\n stations (s, find, f, stacje, ls, q)\n Allows you to find stations by their name\n connections (do, z, szukaj, path)\n Allows you to search for connections from a to b\n trainstats (ts, tp, miejsca, frekwencja)\n Allows you to check seat allocation info for a train.\n trainconnectionstats (tcs)\n Allows you to check the seat allocations on the train connection given it's koleo ID\n aliases Save quick aliases for station names!\n```\n",
"bugtrack_url": null,
"license": "GNU General Public License v3.0",
"summary": "Koleo CLI",
"version": "0.2.137.22",
"project_urls": {
"Homepage": "https://github.com/lzgirlcat/koleo-cli",
"Issue Tracker": "https://github.com/lzgirlcat/koleo-cli/issues",
"Source (GitHub)": "https://github.com/lzgirlcat/koleo-cli"
},
"split_keywords": [
"koleo",
" timetable",
" trains",
" rail",
" poland"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e0726a5d5706a6526394e270ace436d677c73672bf5375cbc2560e2eba3e38a7",
"md5": "bb80af21f3ab3f116d2fd491d43a5b57",
"sha256": "67981c9066867a1227aa0c516e86558643783f1f5e6a89c1a6c5b09f7034ce8e"
},
"downloads": -1,
"filename": "koleo_cli-0.2.137.22-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bb80af21f3ab3f116d2fd491d43a5b57",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 39519,
"upload_time": "2025-07-09T04:28:31",
"upload_time_iso_8601": "2025-07-09T04:28:31.539455Z",
"url": "https://files.pythonhosted.org/packages/e0/72/6a5d5706a6526394e270ace436d677c73672bf5375cbc2560e2eba3e38a7/koleo_cli-0.2.137.22-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d4a9e86c9ef8d1060a6c2921de127e01e5ebaa4cdf2c64ea6080be67850e2f39",
"md5": "05df1409ead988350ef87f6c0fea9ddd",
"sha256": "0e2bd4f490525e9dbf095aaa2136ff38a8ac4427b3fdd32430e15318fe59cccd"
},
"downloads": -1,
"filename": "koleo_cli-0.2.137.22.tar.gz",
"has_sig": false,
"md5_digest": "05df1409ead988350ef87f6c0fea9ddd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 36469,
"upload_time": "2025-07-09T04:28:32",
"upload_time_iso_8601": "2025-07-09T04:28:32.806097Z",
"url": "https://files.pythonhosted.org/packages/d4/a9/e86c9ef8d1060a6c2921de127e01e5ebaa4cdf2c64ea6080be67850e2f39/koleo_cli-0.2.137.22.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 04:28:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lzgirlcat",
"github_project": "koleo-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "rich",
"specs": [
[
"~=",
"14.0.0"
]
]
},
{
"name": "aiohttp",
"specs": [
[
"~=",
"3.12.13"
]
]
},
{
"name": "orjson",
"specs": [
[
"~=",
"3.10.18"
]
]
}
],
"lcname": "koleo-cli"
}
JSON
