{"id":18552422,"url":"https://github.com/andrejewski/please-update","last_synced_at":"2025-06-29T05:34:48.661Z","repository":{"id":57325863,"uuid":"85536447","full_name":"andrejewski/please-update","owner":"andrejewski","description":"Notify when you release a new version","archived":false,"fork":false,"pushed_at":"2020-06-01T01:24:46.000Z","size":1343,"stargazers_count":5,"open_issues_count":13,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-05T00:02:38.829Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andrejewski.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":"2017-03-20T04:51:13.000Z","updated_at":"2018-11-30T10:23:03.000Z","dependencies_parsed_at":"2022-09-21T02:01:07.317Z","dependency_job_id":null,"html_url":"https://github.com/andrejewski/please-update","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrejewski%2Fplease-update","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrejewski%2Fplease-update/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrejewski%2Fplease-update/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrejewski%2Fplease-update/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andrejewski","download_url":"https://codeload.github.com/andrejewski/please-update/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247829493,"owners_count":21002995,"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":[],"created_at":"2024-11-06T21:14:10.404Z","updated_at":"2025-04-09T22:31:51.469Z","avatar_url":"https://github.com/andrejewski.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n\t\u003cbr\u003e\n\t\u003cbr\u003e\n\t\u003cimg width=\"320\" height=\"180\" src=\"https://cdn.rawgit.com/andrejewski/please-update/master/media/logo.svg\" alt=\"Please Update\"\u003e\n\t\u003cbr\u003e\n\t\u003cbr\u003e\n\u003c/h1\u003e\n\n\u003e Notify when you release a new version\n\n[![Example message](media/screenshot.png)](example.js)\n\n```sh\nnpm install please-update\n```\n\n[![npm](https://img.shields.io/npm/v/please-update.svg)](https://www.npmjs.com/package/please-update)\n[![Build Status](https://travis-ci.org/andrejewski/please-update.svg?branch=master)](https://travis-ci.org/andrejewski/please-update)\n[![Coverage Status](https://coveralls.io/repos/github/andrejewski/please-update/badge.svg?branch=master)](https://coveralls.io/github/andrejewski/please-update?branch=master)\n[![Greenkeeper badge](https://badges.greenkeeper.io/andrejewski/please-update.svg)](https://greenkeeper.io/)\n\n## Why even?\n\nCool CLI tools will notify users when a new version releases so they can update.\nPlease Update makes your CLI tool cool, fool.\n\nNote: Programs that run longer than it takes for an HTTPS request can use this too.\n\n## Usage\n\n```js\nimport update from 'please-update'\nimport pkg from './package.json'\n\nupdate({\n  package: pkg.name,\n  version: pkg.version\n}).then(() =\u003e {\n  /* message printed if an update is available */\n})\n```\n\n#### Considerations\nThe [`is-ci`](https://github.com/watson/is-ci) library detects if a command runs on CI servers.\nIf so, no message prints.\n\nThe [`has-yarn`](https://github.com/sindresorhus/has-yarn) library determines whether to display the Yarn upgrade command or the NPM update command.\n\nThe default message will contain [emoji](https://github.com/omnidan/node-emoji) when supported.\n\n## Documentation\nHere are all the supported options.\n\n| Property | Type | Default | Description |\n| -------- | ---- | ------- | ----------- |\n| `package` | string | **required** | The package name\n| `version` | string | **required** | The current, local package version\n| `preferGlobal` | boolean | `false` | Whether to show the global install command\n| `includeTaggedVersions` | boolean | `false` | Whether to count tagged versions (betas, alphas) as versions\n| `persistCheck` | boolean | `true` | Delegate to Please Update the task of remembering the last check time for an update\n| `checkInterval` | number | 24 hours | Number of milliseconds to wait before checking for an update again\n| `lastCheck` | number | 0 | The last check time in milliseconds. Needed if `persistCheck` is false.\n| `displayFn` | (info: object) -\u003e void | *built-in* | Function passed all the data necessary to print an update warning.\n| `preventUpdate` | boolean | `isCI` | Whether to never check or display a warning\n| `silenceErrors` | boolean | `true` | Whether to ignore an error if the NPM registry is down\n\n## Contributing\nContributions are incredibly welcome as long as they are standardly applicable and pass the tests (or break bad ones). Tests are in AVA.\n\n```bash\n# running tests\nnpm run test\n```\n\nFollow me on [Twitter](https://twitter.com/compooter) for updates or for the lolz and please check out my other [repositories](https://github.com/andrejewski) if I have earned it. I thank you for reading.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrejewski%2Fplease-update","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrejewski%2Fplease-update","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrejewski%2Fplease-update/lists"}