{"id":13571136,"url":"https://github.com/infeeeee/kimai2-cmd","last_synced_at":"2025-05-08T01:30:41.789Z","repository":{"id":38332468,"uuid":"194552795","full_name":"infeeeee/kimai2-cmd","owner":"infeeeee","description":"Command line client for Kimai2, the open source, self-hosted time tracker","archived":true,"fork":false,"pushed_at":"2024-02-27T15:12:04.000Z","size":1093,"stargazers_count":26,"open_issues_count":2,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-20T09:21:34.921Z","etag":null,"topics":["command-line","kimai","kimai2","terminal","time-tracker"],"latest_commit_sha":null,"homepage":"","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/infeeeee.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-30T19:23:10.000Z","updated_at":"2025-01-27T22:22:05.000Z","dependencies_parsed_at":"2024-11-05T03:32:51.176Z","dependency_job_id":"2813e6b3-b545-4733-bcca-c56cd33e32ba","html_url":"https://github.com/infeeeee/kimai2-cmd","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infeeeee%2Fkimai2-cmd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infeeeee%2Fkimai2-cmd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infeeeee%2Fkimai2-cmd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infeeeee%2Fkimai2-cmd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infeeeee","download_url":"https://codeload.github.com/infeeeee/kimai2-cmd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252981413,"owners_count":21835423,"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":["command-line","kimai","kimai2","terminal","time-tracker"],"created_at":"2024-08-01T14:00:59.036Z","updated_at":"2025-05-08T01:30:41.037Z","avatar_url":"https://github.com/infeeeee.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"**⚠️ UNMAINTAINED ⚠️**\n\nPRs will be accepted, but issues won't be fixed.\n\nAlternative maintained clients: \n- [Kimai-console](https://github.com/kevinpapst/kimai2-console): Another cli app\n- [Kemai](https://github.com/AlexandrePTJ/kemai): Graphical client\n\n# Kimai2-cmd\n\nCommand line client for [Kimai2](https://www.kimai.org/), the open source, self-hosted time tracker.\n\n![interactive restart gif](assets/interactive-restart.gif)\n\nTo use this program you have to install Kimai2 first!\n\n## Features\n\nThis client is not intended to replace the Kimai webUI, so only basic functions, starting and stopping measurements\n\nCommands: \n- Start, restart and stop measurements\n- List active and recent measurements\n- List projects and activities\n\nUI:\n- Interactive terminal UI with autocomplete\n- Classic terminal UI for integration \n\nIntegration:\n- Portable executable for all three platforms\n- Installer for Windows\n- Generate output for Rainmeter (Windows). More info here: [kimai2-cmd-rainmeter](https://github.com/infeeeee/kimai2-cmd-rainmeter)\n- Generate output for Argos/Kargos/Bitbar (Gnome, Kde, Mac). More info here: [kimai2-cmd-argos](https://github.com/infeeeee/kimai2-cmd-argos)\n\nRequests for integrations with other softwares are welcomed! Just open an issue and show an example output, what you need.\n\n## Installation\n\nDownload from [releases](https://github.com/infeeeee/kimai2-cmd/releases/latest). \n\nYou have to create an API password for your username on your Kimai installation. In Kimai: User menu (Top right corner) -\u003e Edit -\u003e API.\n\n### Notes on Windows\n\nPortable executable or installer available. \n\nInstaller automatically adds the install path to the %PATH% environment variable, so you can use it from command line/powershell system wide. Sign out and in if it's not working.\n\nWith the portable version you have to do this manually. Follow [this tutorial](https://stackoverflow.com/questions/44272416/how-to-add-a-folder-to-path-environment-variable-in-windows-10-with-screensho) or a similar one if you don't know how to do it.\n\n### Notes on Linux/Mac\n\nPortable executable only. On the following terminal examples use the file name you downloaded. \n\nMake the downloaded binary executable:\n```\nsudo chmod +x kimai2-cmd-os\n```\n\nAdd kimai2-cmd to path so you have to just type `kimai` to the terminal:\n```\nsudo ln -s /path/to/kimai2-cmd-os /usr/bin/kimai\n```\n\nTo remove:\n```\nsudo rm /usr/bin/kimai\n```\n\n### Install with npm\n\nIf npm installed you can install it with the following command:\n\n```\nnpm install -g infeeeee/kimai2-cmd\n```\n\n## Usage\n\nTwo usage modes: interactive and classic ui\n\n### Interactive ui\n\n![interactive start gif](assets/interactive-start.gif)\n\nIf you start without any commands, you will get to the interactive UI. Use your keyboard's arrow keys for navigation. On the `Start new measurement` menu item you can search for project and activity names.\n\nYou can exit with ctrl+c any time.\n\n### Classic ui\n\nYou can find all the options in the help:\n\n```\n$ kimai2-cmd --help\n\nUsage: kimai2-cmd [options] [command]\n\nCommand line client for Kimai2. For interactive mode start without any commands. To generate settings file start in interactive mode!\n\nOptions:\n  -V, --version               output the version number\n  -v, --verbose               verbose, longer logging\n  -i, --id                    show id of elements when listing\n  -b, --argosbutton           argos/bitbar button output\n  -a, --argos                 argos/bitbar output\n  -h, --help                  output usage information\n\nCommands:\n  start [project] [activity]  start selected project and activity\n  restart [id]                restart selected measurement\n  stop [id] [description]     stop all or selected measurement measurements, [id] is optional, [description] is optional but needs [id]\n  rainmeter                   update rainmeter skin\n  list-active                 list active measurements\n  list-recent                 list recent measurements\n  list-projects               list all projects\n  list-activities             list all activities\n  url                         prints the url of the server\n```\n\nProject and activity names are case insensitive. If your project or activity name contains a space, wrap it in double or single quotes. This example starts project named `foo` with activity named `bar bar`:\n\n```\nkimai2-cmd start \"foo\" \"bar bar\"\n```\n\n### Settings and first run\n\nAll settings stored in the settings.ini file. Place this file to the same directory as the executable. If no settings file found you will drop to the interactive UI, where you can add your settings:\n\n![interactive settings gif](assets/interactive-settings.gif)\n\nYou can create your settings.ini file manually, by downloading, renaming and editing [settings.ini.example](https://github.com/infeeeee/kimai2-cmd/blob/master/settings.ini.example).\n\nOn the windows installer version settings.ini location: `C:\\Users\\Username\\AppData\\Roaming\\kimai2-cmd\\settings.ini`\n\nYou can also store the settings.ini file in custom location, just export the full path to the `KIMAI_CONFIG` variable, something like this:\n\n```bash\nexport KIMAI_CONFIG=$XDG_CONFIG_HOME/kimai2/settings.ini\n```\n\nIntegration settings are not asked during first run, you have to change them manually in settings.ini. If you don't use an integration, you can safely ignore it's settings.\n\n## Development version\n\n### Installation\n\nPrerequisites:\n- node js 10+\n- git\n\n```\ngit clone https://github.com/infeeeee/kimai2-cmd\ncd kimai2-cmd\nnpm i\n```\n\n### Build\n\nPrerequisite: globally installed [pkg](https://github.com/zeit/pkg): \n\n```\nnpm i pkg -g\n```\n\nBuild for current platform and architecture\n\n```\nnpm run build-current\n```\n\nBuild x64 executables for linux, mac on linux or on mac\n\n```\nnpm run build-nix\n```\n\nAbout building for other platforms see pkg's documentation, or open an issue and I can build it for you.\n\n### Installer (Windows only)\n\nPrerequisite: [Inno Setup](http://www.jrsoftware.org/isinfo.php)\n\n- Create a windows build: `npm run build-current`\n- Open `kimai2-innosetup.iss` in Inno Setup\n\n### Usage\n\nFor interactive mode just simply:\n\n```\nnpm start\n```\n\nFor usage with options you have pass a `--` before the options. You don't need this if you don't use options just commands:\n\n```\nnpm start -- -V\nnpm start start foo bar\n```\n\nOn the first run it will ask for your settings, but you can just copy settings.ini.example to settings.ini and modify it with your favorite text editor\n\n## Troubleshooting\n\nIf you find a bug open an issue here! \n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfeeeee%2Fkimai2-cmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfeeeee%2Fkimai2-cmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfeeeee%2Fkimai2-cmd/lists"}