# npm-star

> npm-star [![npm version](https://img.shields.io/npm/v/npm-star.svg?style=flat)](https://www.npmjs.com/package/npm-star) ===

Latest version **0.0.2** (published 2017-06-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-star
pnpm add npm-star
yarn add npm-star
bun add npm-star
```

Provides the commands `npm-star`, `yarn-star`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-06-28 |
| First published | 2017-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | yes |
| GitHub stars | 11 |
| Author | Lim Chee Aun |
| Maintainers | cheeaun |
| Keywords | cli-app, cli, npm, yarn, star, github, stars |

## Links

- npm: https://www.npmjs.com/package/npm-star
- Repository: https://github.com/cheeaun/npm-star
- Homepage: https://github.com/cheeaun/npm-star#readme
- Issues: https://github.com/cheeaun/npm-star/issues
- npm.io page: https://npm.io/package/npm-star

## Dependencies (4)

- [got](https://npm.io/package/got.md) ~7.0.0
- [ora](https://npm.io/package/ora.md) ~1.3.0
- [netrc](https://npm.io/package/netrc.md) ~0.1.4
- [gh-got](https://npm.io/package/gh-got.md) ~6.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2017-06-28
- 0.0.1 — 2017-06-28

## README

npm-star [![npm version](https://img.shields.io/npm/v/npm-star.svg?style=flat)](https://www.npmjs.com/package/npm-star)
===

> Star GitHub repositories of your project's npm dependencies. First inspired by [bundle-star](https://github.com/ma2gedev/bundle-star).

<img src="screenshot.gif" alt="Screenshot of npm-star">

Install
---

```
npm install --global npm-star
# or
yarn global add npm-star
```

### Local install

```
npm install --save-dev npm-star
# or
yarn add --dev npm-star
```

Usage
---

### Setup a `.netrc` file

`npm-star` depends on `.netrc` to access the GitHub API. Put your GitHub credentials into `.netrc` file (located at `~/.netrc`), so that you can access the GitHub API.

Here's a sample `.netrc` file. Execute `chmod 600 ~/.netrc` to avoid permission error.

```
machine api.github.com
  login <your github account>
  password <your github token, from <https://github.com/settings/tokens>
```

⚠️ **IMPORTANT**: Make sure `public_repo` is checked ✅ when creating a new token. This is needed for starring repositories 🌟.

### Use `npm-star` or `yarn-star`

```
npm-star
# or
yarn-star
```

If it's a local installation, add as `postinstall` script in `package.json` 😏:

```
"scripts": {
  ...,
  "postinstall": "npm-star"
}
```

Related
---

- [`bundle-star`](https://github.com/ma2gedev/bundle-star) - Star github repositories automatically when you bundle installing
- [`starring`](https://github.com/ritz078/starring) - Automatically star the npm-packages that you are using on GitHub.
- [`gh-star`](https://github.com/fedebertolini/gh-star) - NodeJS app that stars the GitHub repos referenced in a package.json file
- [Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)
- [The `.netrc` file](https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html)

License
---

[MIT](https://cheeaun.mit-license.org/) © [Lim Chee Aun](http://cheeaun.com)

---
_Source: https://npm.io/package/npm-star · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._