# configure-jfrog

> Configure JFrog Artifactory for an NPM package.

Latest version **1.0.1** (published 2019-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install configure-jfrog
pnpm add configure-jfrog
yarn add configure-jfrog
bun add configure-jfrog
```

Provides the command `configure-jfrog`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-02-13 |
| First published | 2018-08-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mark Brouch |
| Maintainers | markbrouch |
| Keywords | jfrog, artifactory, npx |

## Links

- npm: https://www.npmjs.com/package/configure-jfrog
- Repository: https://github.com/doximity/configure-jfrog
- Homepage: https://github.com/doximity/configure-jfrog#readme
- Issues: https://github.com/doximity/configure-jfrog/issues
- npm.io page: https://npm.io/package/configure-jfrog

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [yargs](https://npm.io/package/yargs.md) ^12.0.1
- [inquirer](https://npm.io/package/inquirer.md) ^6.2.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.2.0

## Recent versions

- 1.0.1 (latest) — 2019-02-13
- 1.0.0 — 2018-08-21

## README

# <center>🐸 `configure-jfrog` 🐸</center>

The command-line utility `configure-jfrog` is used to configure an NPM repository for using a [JFrog SaaS Artifactory](https://jfrog.com/knowledge-base/how-to-access-the-your-artifactory-saas-online-instance-and-do-a-password-reset/) registry.

## Installation

No installation is necessary when using `npx`, although you may globally install with `npm install --global configure-jfrog`. This is only recommended if you do not desire the latest version of the utility on each run.

## Usage

Run the CLI command `configure-jfrog` with optional flags and answer any prompts that may appear.

```bash
configure-jfrog [--directory -d] [--server-name -n] [--artifactory-key -k] [--registry -r] [--scope -s]
```

> ⚠️ WARNING: configure-jfrog will replace any existing .npmrc file at the specified directory.

### Flags

| name              | alias | description                                                                                                                                                                                                                                   |
| ----------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `directory`       | `-d`  | The relative or absolute path to the directory in which to configure NPM. This should be the root directory where your `package.json` lives.                                                                                                  |
| `server-name`     | `-n`  | The JFrog Artifactory server name: _https://__\<server-name>\_\_.jfrog.io_                                                                                                                                                                    |
| `artifactory-key` | `-k`  | Your Artifactory API key. You must [generate](https://www.jfrog.com/confluence/display/RTF/Updating+Your+Profile#UpdatingYourProfile-APIKey) one for your user profile.                                                                       |
| `registry`        | `-r`  | The name of the registry on Artifactory you would like to use.                                                                                                                                                                                |
| `scope`           | `-s`  | The [NPM `@scope`](https://docs.npmjs.com/misc/scope) that your private packages are published to. It is best practice to always publish private packages under a scope so that there are no conflicts with public packages of the same name. |

### Example

```bash
npx configure-jfrog -d ~/Sites/example-package -n doximity -k $ARTIFACTORY_API_KEY -r npm-doximity -s dox
```

## Run as npm script

It may be helpful to create an NPM script to automatically configure your repository for new users:

```json
{
  "scripts": {
    "configure-npm":
      "npx configure-jfrog -d . -n doximity -k $ARTIFACTORY_API_KEY -r npm-doximity -s dox"
  }
}
```

This will allow a new user to set up the private registry using their credentials.

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