{"id":18569886,"url":"https://github.com/lcfd/trak","last_synced_at":"2025-04-10T06:32:20.268Z","repository":{"id":198326848,"uuid":"700575539","full_name":"lcfd/trak","owner":"lcfd","description":"Keep a record of the time you dedicate to your projects. ⚠️ Under HEAVY active development ⚠️","archived":false,"fork":false,"pushed_at":"2025-01-27T08:18:31.000Z","size":2391,"stargazers_count":11,"open_issues_count":25,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-21T12:16:05.769Z","etag":null,"topics":["cli","command-line","command-line-tool","python","report","time","time-tracking","tracking"],"latest_commit_sha":null,"homepage":"https://usetrak.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lcfd.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":"2023-10-04T21:18:37.000Z","updated_at":"2025-02-18T09:37:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"133842b6-c4bb-46e4-92d4-f0db2a6e2ff9","html_url":"https://github.com/lcfd/trak","commit_stats":{"total_commits":81,"total_committers":3,"mean_commits":27.0,"dds":0.0864197530864198,"last_synced_commit":"ce1c0a8a60cb63044bc0828b701a17fb0cc28575"},"previous_names":["lcfd/trak"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lcfd%2Ftrak","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lcfd%2Ftrak/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lcfd%2Ftrak/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lcfd%2Ftrak/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lcfd","download_url":"https://codeload.github.com/lcfd/trak/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248168331,"owners_count":21058817,"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":["cli","command-line","command-line-tool","python","report","time","time-tracking","tracking"],"created_at":"2024-11-06T22:35:34.010Z","updated_at":"2025-04-10T06:32:19.736Z","avatar_url":"https://github.com/lcfd.png","language":"Python","funding_links":[],"categories":["Time Tracking CLI Tools"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/lcfd/trak\"\u003e\n    \u003cimg src=\"./assets/banner.png\" alt=\"Trak banner\"\u003e\n  \u003c/a\u003e\n\n  \u003ch1 align=\"center\"\u003etrak\u003c/h1\u003e\n\n  \u003cp align=\"center\"\u003e\n    \u003cbr /\u003e\n    Trak is a CLI to track the time you spend on projects, with useful reports and analytics.\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    For freelancers, by a freelance.\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://usetrak.com\"\u003eWebsite\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/lcfd/trak/issues\"\u003eIssues\u003c/a\u003e\n    ·\n    \u003ca href=\"https://usetrak.com/docs/\"\u003eDocumentation\u003c/a\u003e\n    •\n    \u003ca href=\"https://github.com/lcfd/trak/discussions\"\u003eFeedback\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n## Installation\n\n### Pypi\n\n[On Pypi](https://pypi.org/project/trakcli/) you can find the package under the `trakcli` name.\n\nYou can install it with pip:\n\n```bash\npip install trakcli\n```\n\nor with `pipx`:\n\n```bash\npipx install trakcli\n```\n\n### Brew\n\n`brew install lcfd/trak/trak`\n\n### Nix\n\nTry it:\n\n```bash\nnix shell nixpkgs/master#trak\n```\n\nInstall it:\n\n```bash\nnix profile install nixpkgs/master#trak\n```\n\n### Local\n\nRun `poetry build` and then\n\n```bash\n# x.x.x = The version you have used to do the build.\npipx install ./dist/trakcli-x.x.x-py3-none-any.whl\n```\n\nto install `trak` using the wheel file.\n\n## Usage\n\nThe package has the useful `--help` command that explains all the commands.\n\n`trak --help`\n\nThe CLI guides you through what you should and must do with specific messages.\n\n### Basic commands\n\n```bash\n# Start a new session\ntrak start \u003cproject-name\u003e\n\n# Stop the current session\ntrak stop\n\n# Show the elapsed time of the current session\ntrak status\n\n# Show the amount of hours spend on the project\ntrak report project \u003cproject-name\u003e\n```\n\nStart tracking a billable project:\n\n`trak start pasta -b`\n\nStart tracking a project on a specific category/topic:\n\n`trak start pasta -c rigatoni`\n\n## Starship\n\nThere is a dedicated command that outputs clean strings for tools like Starship:\n\n`trak status -s` or `trak status --starship`\n\nTo see the status in your terminal line open `$HOME/.config/starship.toml`\nand put this snippet inside of it:\n\n```bash\n[custom.trak]\ncommand = \"\"\" trak status -s \"\"\"\nwhen = \"trak status\"\nshell = \"sh\"\n```\n\nThis way you can stay updated on the state of your session wherever you integrate this command.\n\n## Distribution\n\n### Create dist tar\n\n`tar --exclude=\".venv\" --exclude=\"dist\" --exclude=\".mypy_cache\" --exclude=\".pytest_cache\" --exclude=\"**/__pycache__\" -czvf dist.tar.gz cli`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flcfd%2Ftrak","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flcfd%2Ftrak","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flcfd%2Ftrak/lists"}