Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/null-care/devops-npmrc
CLI tool for adding Azure DevOps npm repository to .npmrc/.yarnrc.yml
https://github.com/null-care/devops-npmrc
Last synced: 9 days ago
JSON representation
CLI tool for adding Azure DevOps npm repository to .npmrc/.yarnrc.yml
- Host: GitHub
- URL: https://github.com/null-care/devops-npmrc
- Owner: null-care
- Created: 2023-07-26T06:53:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-26T12:49:05.000Z (over 1 year ago)
- Last Synced: 2024-11-08T12:45:22.313Z (about 1 month ago)
- Language: TypeScript
- Size: 28.3 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - null-care/devops-npmrc - CLI tool for adding Azure DevOps npm repository to .npmrc/.yarnrc.yml (TypeScript)
README
# DevOps `.npmrc` CLI
[](https://www.npmjs.com/package/devops-npmrc/)
[](https://nodei.co/npm/devops-npmrc/)
CLI tool for adding Azure DevOps artifact feed to .npmrc on unix based systems like macOS or Linux.
> _Works for both `npm` and `yarn`._
## Prerequisites
To use the tool you will need:
- DevOps organization name
- DevOps artifact feed name
- A personal access token (_global file only_)
1. Find the name of your `organization` and `feed`
- Go to [https://dev.azure.com/](https://dev.azure.com/) and log in to your organization.
- Select the project where your feed is located and navigate to `Artifacts` in the menu to the left.
- Select the feed you wish to add to `.npmrc` from the dropdown menu in the top left corner.
- Retrieve `organization` and `feed` from the url: `dev.azure.com//Your.Project/_artifacts/`
2. Generate a `personal access token`
- Generate a [Personal Access Token](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate) with Packaging read & write scopes.
## Quick start
> Before using the tool make sure you have all the [prerequisites](#prerequisites).
Add a registry to the global `.npmrc` file
```bash
npx devops-npmrc@latest
```
To be able to install packages you also need to add a `.npmrc` file to your project
```bash
# cd to your project
cd /path/to/your/project
# Then run
npx devops-npmrc@latest -p
```
To verify that everything is working you can run the following
```bash
npm config get registry
# Or using yarn
yarn info
```
## Usage
Add a registry to the global `.npmrc` file
```bash
npx devops-npmrc@latest
```
Add a `.npmrc` file to a project
```bash
npx devops-npmrc@latest -p
```
### Available options
- `-p`, `--project` – _Generate a `.npmrc` file for a project instead of a global file_
- `-V`, `--version` – _output the version number_
- `-h`, `--help` – _display help_
### Yarn
If you are using `yarn` you can select `yarn` when asked what package manager you are using, this will generate both a `.npmrc` file and a `.yarnrc.yml` file.
---
## Contribute
If you wish to contribute, here are some steps to get started:
1. [Fork the repo](https://github.com/null-care/devops-npmrc/fork) and clone it to your local machine.
2. Install dependencies by running `yarn`
3. Make your changes
4. [Build and bundle the project](#build-and-bundle-the-project)
5. Push to github and [submit a pull request](https://github.com/null-care/devops-npmrc/compare)
### Build and bundle the project
Build the project
```bash
yarn build
```
Bundle the project
```bash
yarn bundle
```
Run the executable _(located in the bin directory)_
```bash
yarn run-bin
```