{"id":20277349,"url":"https://github.com/bitjson/wip","last_synced_at":"2025-09-21T18:46:07.173Z","repository":{"id":39042718,"uuid":"53169130","full_name":"bitjson/wip","owner":"bitjson","description":"WIP \u0026 naenae: CLI utilities to easily manage Work In Progress with Git","archived":false,"fork":false,"pushed_at":"2023-11-25T14:12:22.000Z","size":561,"stargazers_count":48,"open_issues_count":15,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-02T06:17:49.846Z","etag":null,"topics":["git","naenae","ship","simple","sound-effects","version-control","wip","work-in-progress"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitjson.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-03-04T22:18:22.000Z","updated_at":"2024-02-25T11:00:37.000Z","dependencies_parsed_at":"2023-11-25T15:24:24.864Z","dependency_job_id":"1e9616d5-0026-4aba-96af-70116c1bea5a","html_url":"https://github.com/bitjson/wip","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitjson%2Fwip","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitjson%2Fwip/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitjson%2Fwip/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitjson%2Fwip/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitjson","download_url":"https://codeload.github.com/bitjson/wip/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248351449,"owners_count":21089270,"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":["git","naenae","ship","simple","sound-effects","version-control","wip","work-in-progress"],"created_at":"2024-11-14T13:18:04.968Z","updated_at":"2025-09-21T18:46:02.152Z","avatar_url":"https://github.com/bitjson.png","language":"JavaScript","readme":"[![npm](https://img.shields.io/npm/v/wip.svg)](https://www.npmjs.com/package/wip) [![npm](https://img.shields.io/npm/dt/wip.svg)](https://www.npmjs.com/package/wip)\n[![npm](https://img.shields.io/npm/l/wip.svg)](https://www.npmjs.com/package/wip)\n\n# WIP, WIP, \u0026amp; NAENAE\n\n`wip` and `naenae` are command line utilities to better manage your WIP (Work In Progress) with Git.\n\n`wip` saves your progress by committing the current state of your Git repo with a commit message of \"WIP\" (a common convention). `naenae` squashes all your \"WIP\" commits together and lets you give the commit a better title. By periodically saving your progress, you're free to write, rewrite, and ship faster.\n\n![Demo of the wip and naenae command line utilities](/assets/wip-naenae-demo.gif)\n\n## Install\n\n`wip` and `naenae` run in Node.js, so you'll need to have that installed, type this in the terminal:\n\n```bash\n$ npm install -g wip\n```\n\nIf you don't have it already, you'll need to [install Git, too](https://desktop.github.com/).\n\n## Usage\n\nWhen you want to save your work, type this in the terminal:\n\n```bash\n$ wip\n```\n\nWhen you've finished a big chunk of work and you're ready to ship it, type this:\n\n```bash\n$ naenae\n```\n\nNaenae will archive your work for safe keeping (using `wip archive`), and then sqash all your WIPs into a single git commit.\n\n### HELPMEIT'SALLBROKEN\n\nNo worries! Thanks to `wip`, you've been meticulously tracking your work with Git, so everything is gonna' be ok.\n\nWhen things break, you can see everything you've changed since the last commit with something like:\n```bash\n$ git diff HEAD^ HEAD\n```\n\nOr you could just download the [GitHub Desktop](https://desktop.github.com/) app like the rest of us. [SourceTree](https://www.sourcetreeapp.com/) is also a great option, especially if you're looking for more control.\n\n## FAQs\n\nHere's some answers to questions humans might ask if they ever read this.\n\n### How do I turn the sound effects off?\n\nYou read that right – `wip` and `naenae` have some _sweet sound effects_. They're **on** by default (so everyone around you can share in your progress), but you can turn them off by typing:\n\n```bash\n$ wip silently\n```\n\n### Someone turned my sound effects off, how do I get them back?\n\nThat's terrible! But all is not lost – just:\n```bash\n$ wip loudly\n```\n\n### 💩, why can't I see the emoji?\nUnfortunately, some shells don't support emoji. If you're on Windows, you may need to upgrade to something like [Cygwin](https://www.cygwin.com/). If you want to avoid seeing the \"unrecognized character\" boxes (or if you just hate fun) you can:\n```bash\n$ wip without emoji\n```\n\nAnd when you're ready to rejoin civilization:\n```bash\n$ wip with emoji\n```\n\n### All the hipsters use commitizen.\nAnd you can too! Turn it on:\n```bash\n$ wip with commitizen\n```\n\nYou can also turn it back off:\n```bash\n$ wip without commitizen\n```\n### Have you tried putting it in a watch task and commiting on save?\n```bash\nnpm install -g watch\nwip silently\nwatch wip --ignoreDotFiles\n```\nYou won't be disappointed.\n\n## License\n\nMIT\n\n---\n\n[![xkcd commic about git](https://imgs.xkcd.com/comics/git.png)](https://xkcd.com/1597/)\n\n\nNaming inspired by Silentó - Watch Me (Whip/Nae Nae):\n\n[![Silentó - Watch Me (Whip/Nae Nae) (Official)](http://img.youtube.com/vi/vjW8wmF5VWc/0.jpg)](http://www.youtube.com/watch?v=vjW8wmF5VWc)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitjson%2Fwip","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitjson%2Fwip","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitjson%2Fwip/lists"}