{"id":22691117,"url":"https://github.com/radiovisual/timecard","last_synced_at":"2025-04-12T22:54:06.672Z","repository":{"id":65473033,"uuid":"41996099","full_name":"radiovisual/timecard","owner":"radiovisual","description":"Keep track of your project development time.","archived":false,"fork":false,"pushed_at":"2017-02-17T18:06:41.000Z","size":313,"stargazers_count":20,"open_issues_count":10,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T22:53:40.584Z","etag":null,"topics":["clockin","clockout","time-management","time-manager","timecard"],"latest_commit_sha":null,"homepage":null,"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/radiovisual.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":"2015-09-06T09:07:06.000Z","updated_at":"2024-07-05T20:45:21.000Z","dependencies_parsed_at":"2023-01-25T12:01:24.122Z","dependency_job_id":null,"html_url":"https://github.com/radiovisual/timecard","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radiovisual%2Ftimecard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radiovisual%2Ftimecard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radiovisual%2Ftimecard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radiovisual%2Ftimecard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/radiovisual","download_url":"https://codeload.github.com/radiovisual/timecard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248643044,"owners_count":21138353,"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":["clockin","clockout","time-management","time-manager","timecard"],"created_at":"2024-12-10T01:09:28.200Z","updated_at":"2025-04-12T22:54:06.649Z","avatar_url":"https://github.com/radiovisual.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# timecard\n\n\u003e Keep track of your project development time.\n\n[![Build Status](https://travis-ci.org/radiovisual/timecard.svg?branch=master)](https://travis-ci.org/radiovisual/timecard) [![Coverage Status](https://coveralls.io/repos/github/radiovisual/timecard/badge.svg?branch=master)](https://coveralls.io/github/radiovisual/timecard?branch=master)\n\n![timecard print screenshot](media/timecard-print-screenshot.png)\n\n## Install\n```sh\n$ npm install --global timecard\n```\n\n## Usage\n\nTo create a **new timecard** for your project\n\n```\n$ timecard new\n```\n\nTo **clockin** (start working)\n\n```\n$ timecard clockin\n```\n\nTo **clockout** (stop working)\n\n```\n$ timecard clockout\n```\n\nTo see a **print summary** of your time\n\n```\n$ timecard print\n```\n\n**Tip:** If you prefer the shorthand, all of these commands have flag aliases. Check the [help output](https://github.com/radiovisual/timecard#options) for details.\n\n## Messages\n\nYou can add a message to your shifts via the `clockin` and `clockout` commands.\n\nTo add a message, simply include the `-m` or `--message` options with your clockin\nand clockout commands. Here are some examples:\n\n```\n$ timecard clockin -m \"Refactored tests to use AVA\"\n$ timecard clockout --message \"Fixed Issue #23\"\n```\nThe two lines above would result in two messages being added to the shift:\n\n![messages screenshot](media/timecard-messages.png);\n\nIf you want to add more messages to your shift, you can edit the `.timecard.json`\nfile manually. In the future, I would like to make it possible to [add/edit messages\nto a shift via the cli](https://github.com/radiovisual/timecard/issues/32),\nbut for now, you can only add one message on clockin, and one message on\nclockout for a total of two messages. Pull requests are welcome if anyone would like\nto help add these features.\n\n## `.timecard.json`\n\nWhen you run the `timecard new` command, Timecard creates a hidden file called `.timecard.json`. This is the file\nwhere your project times are recorded.\n\nSome important notes to consider regarding the timecard file:\n\n1) **Version Control:** Remember to update your `.gitignore` file if you don't want the timecard file under version control.\n\n2) **For Node.js developers:** If your project contains a `package.json` file, then Timecard assumes that the directory with the `package.json` file is the root directory, and places the `.timecard.json` file in the root. You can run any Timecard command from any of your project's sub-directories.\n\n3) **Non-Node.js Projects:** (or if your project DOES NOT contain a `package.json` file), then you can still use Timecard, you will just need to make sure that you are running the Timecard commands from the same directory each time (preferably in your project root).\n\n4) **Manual timecard edits:** Sometimes it will be necessary to update the `.timecard.json` file manually (if you forgot to clockout, for example), which is fine, just remember that this file must be valid JSON.\n\n\n## Options\n\n```\n$ timecard --help\n\n  Keep track of your project development time\n\n  Get timecard setup with the 'new' command, then use the 'clockin' and 'clockout' commands\n  to record your time. When you want to see a summary of your time, use the 'print' command.\n\n  Commands\n    timecard new            Setup a blank timecard for your project\n    timecard clockin        Set the start time for your shift\n    timecard clockout       Set the end time for your shift\n    timecard print          Print a summary of your time\n\n  Options\n    -h, --help              Show this help message\n    -v, --version           Show the current timecard version\n    -i, --clockin           Alias for the clockin command\n    -o, --clockout          Alias for the clockout command\n    -n, --new               Alias for the new command\n    -p, --print             Alias for the print command\n    --no-prompt             Use with `new` to silence all prompts and overwrite existing timecard\n    --message, -m           Include a message summary to your shift (via clockin and clockout)\n\n```\n## Tips\n\n- **Export Timecard to Text File:** If you want something easier to read than a .json\nfile, you can pipe the output of the `print` command to a text file from the command line\nlike this:\n  ```\n  $ timecard print \u003e timecard.txt\n  ```\n\n## License\n\nMIT @ [Michael Wuergler](http://numetriclabs.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradiovisual%2Ftimecard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fradiovisual%2Ftimecard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradiovisual%2Ftimecard/lists"}