# @oyvinmar-forks/nel

> Command line interface for common development tasks.

Latest version **0.5.30** (published 2023-11-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install @oyvinmar-forks/nel
pnpm add @oyvinmar-forks/nel
yarn add @oyvinmar-forks/nel
bun add @oyvinmar-forks/nel
```

Provides the command `nel`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.30 |
| Published | 2023-11-06 |
| First published | 2021-10-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 29 |
| Unpacked size | 77.7 KB |
| Known vulnerabilities | 0 (+14 in 3 direct dependencies) |
| Install scripts | no |
| Maintainers | oyvinmar |

## Links

- npm: https://www.npmjs.com/package/@oyvinmar-forks/nel
- Repository: https://github.com/oyvinmar/nel
- Homepage: https://github.com/oyvinmar/nel#readme
- Issues: https://github.com/oyvinmar/nel/issues
- npm.io page: https://npm.io/package/@oyvinmar-forks/nel

## Dependencies (29)

- [ora](https://npm.io/package/ora.md) ^6.1.2
- [tar](https://npm.io/package/tar.md) ^6.1.13
- [zod](https://npm.io/package/zod.md) ^3.19.1
- [open](https://npm.io/package/open.md) ^8.4.2
- [tsup](https://npm.io/package/tsup.md) ^7.2.0
- [chalk](https://npm.io/package/chalk.md) ^5.2.0
- [execa](https://npm.io/package/execa.md) ^6.1.0
- [figlet](https://npm.io/package/figlet.md) ^1.5.2
- [globby](https://npm.io/package/globby.md) ^13.1.3
- [marked](https://npm.io/package/marked.md) ^4.2.12
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [figures](https://npm.io/package/figures.md) ^5.0.0
- [find-up](https://npm.io/package/find-up.md) ^6.3.0
- [p-retry](https://npm.io/package/p-retry.md) ^5.1.2
- [checksum](https://npm.io/package/checksum.md) ^1.0.0
- [enquirer](https://npm.io/package/enquirer.md) ^2.3.6
- [commander](https://npm.io/package/commander.md) ^9.5.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.1
- [ts-pattern](https://npm.io/package/ts-pattern.md) ^4.2.1
- [typescript](https://npm.io/package/typescript.md) ^5.2.2
- [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^7.1.0
- [log-symbols](https://npm.io/package/log-symbols.md) ^5.1.0
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^9.1.0
- [@types/marked](https://npm.io/package/@types/marked.md) ^4.0.7
- [terminal-link](https://npm.io/package/terminal-link.md) ^3.0.0
- [external-editor](https://npm.io/package/external-editor.md) ^3.1.0
- [gradient-string](https://npm.io/package/gradient-string.md) ^2.0.2
- [marked-terminal](https://npm.io/package/marked-terminal.md) ^5.1.1
- [@types/marked-terminal](https://npm.io/package/@types/marked-terminal.md) ^3.1.3

## Recent versions

- 0.5.30 (latest) — 2023-11-06
- 0.5.29 — 2023-10-10
- 0.5.28 — 2023-10-06
- 0.5.27 — 2023-10-06
- 0.5.26 — 2023-09-05
- 0.5.25 — 2023-08-29
- 0.5.24 — 2023-04-21
- 0.5.23 — 2023-03-26
- 0.5.22 — 2023-03-14
- 0.5.21 — 2023-03-14
- 0.5.20 — 2023-02-28
- 0.5.19 — 2023-02-22
- 0.5.18 — 2023-02-16
- 0.5.17 — 2023-01-30
- 0.5.16 — 2023-01-05
- … 26 more at https://npm.io/package/@oyvinmar-forks/nel/versions

## README

# Nel

Command line interface for common development tasks.

## 🏗️ Install

Install Nel globally using npm or your favorite package manager:

```
npm install --global @oyvinmar-forks/nel
```

### Install Github CLI

Some of the commands in Nel require the Github CLI to be installed. You can install it by following the instructions here: https://cli.github.com/manual/installation

After installation you need to login to Github using the CLI:

```
gh auth login
```

### Setup jira

For the jira commands to work you need to set up a token for your jira account and add email to a `.nelrc` file.

1. Go to: https://id.atlassian.com/manage-profile/security/api-tokens
2. Create a new token
3. Add `export JIRA_TOKEN=<your-token>` to your `.bashrc` or `.zshrc`

### Configuration

Nel will start in current working directory and search up the directory tree for config file. It supports multiple formats. For example `.nelrc.json`, `.nelrc.yml`, `.nelrc.js`, and `.nelrc.cjs`. For full list see [cosmiconfig](https://github.com/davidtheclark/cosmiconfig).

Jira email should always be specified in the config file. To change development defaults you can add a `development` section to the config file. See: [`nel dev`](#dev) for options.

Example config file `.nelrc.yml`:

```yaml
jira:
  email: <your-jira-email>
development:
  ardoq: # Must match name specified in the projects package.json file
    environment: local
    subdomain: piedpiper
    open: false
  ardoq-discover:
    environment: engagement
    subdomain: marintech
  ardoq-login:
    environment: appsec
    subdomain: piedpiper
  ardoq-surveys:
    environment: test
    subdomain: martech
  my-awesome-project:
    port: 8080
```

## 🚀 Usage

```
nel --help
```

<!-- usage-start -->

```Usage: nel [options] [command]

Options:
  -v, --version                      Print current version
  -h, --help                         display help for command

Commands:
  interactive|i                      Interactive prompt
  check                              Check setup and config
  open [options] [jira_key...]       Open project or jira ticket
  merge [options]                    Merge pull request
  dev [options]                      Start dev server
  watch                              Watch project
  build                              Build project
  deploy                             Deploy project
  release                            Release project
  vc                                 Interactively choose a version control
                                     command.
  branch [name]                      Create a new branch
  checkout-pr|cpr                    Checkout pull request
  delete-branches|d [options]        Delete local branches
  checkout|co [options]              Checkout branch
  jira                               Interactively choose a Jira command.
  link [options] <package-names...>  Link ardoq package
  unlink                             Unlink shared-ui package
  test [options]                     Test project
```

<!-- usage-end -->

### 👤 Aliases

Don't want to type `nel` every time? Here are some suggested alias you can copy into your shells rc file(s):

```bash
alias dev='nel dev'
alias build='nel build'
alias watch='nel watch'
alias deploy='nel deploy'
alias merge='nel merge'
alias test='nel test'
alias cb='nel vc co'
alias cpr='nel vc cpr'
```

## 🛠️ Commands

<!-- commands-start -->

- [`nel interactive`](#interactive)
- [`nel check`](#check)
- [`nel open`](#open)
- [`nel merge`](#merge)
- [`nel dev`](#dev)
- [`nel watch`](#watch)
- [`nel build`](#build)
- [`nel deploy`](#deploy)
- [`nel release`](#release)
- [`nel vc`](#vc)
- [`nel branch`](#branch)
- [`nel checkout-pr`](#checkout-pr)
- [`nel delete-branches`](#delete-branches)
- [`nel checkout`](#checkout)
- [`nel jira`](#jira)
- [`nel link`](#link)
- [`nel unlink`](#unlink)
- [`nel test`](#test)

### interactive

Interactive prompt

```
Usage: nel interactive|i [options]

Interactively choose a command to run.

Options:
  -h, --help  display help for command

```

### check

Check setup and config

```
Usage: nel check [options]

Check that Github CLI is installed and that we can find and read a config file.

Options:
  -h, --help  display help for command

```

### open

Open project or jira ticket

```
Usage: nel open [options] [jira_key...]

Command for opening various development related tools or services. Currently supports opening jira ticket or current project in a browser

Options:
  -s, --subdomain <org-name>  Subdomain (organisation name) to open in browser
  -e, --environment <env>     Choose environment (choices: "local", "test",
                              "platform", "insight", "integration",
                              "engagement", "prod")
  -h, --help                  display help for command

```

### merge

Merge pull request

```
Usage: nel merge [options]

Squashes the current branch into main/master. Prompts user for deploy/release of project and closing of related jira after merge.

Options:
  -y, --yes    Deploy and close jira after merge.
  -f, --force  Force merge without checking status.
  -h, --help   display help for command

```

### dev

Start dev server

```
Usage: nel dev [options]

Starts a dev server in the current project if it finds a valid script in package.json. It opens a browser window after the dev server has started.

Options:
  -n, --no-open               Don't open browser after starting dev server.
  -s, --subdomain <org-name>  Subdomain (organisation name) to open in the
                              browser.
  -p, --port <number>         Port number to open in the browser (default:
                              3000). Should be the port the dev server is
                              using.
  -e, --environment <env>     Choose environment (choices: "local", "test",
                              "platform", "insight", "integration",
                              "engagement", "prod")
  -h, --help                  display help for command

```

### watch

Watch project

```
Usage: nel watch [options]

Runs the watch script in a project.

Options:
  -h, --help  display help for command

```

### build

Build project

```
Usage: nel build [options]

Runs the build script in a project.

Options:
  -h, --help  display help for command

```

### deploy

Deploy project

```
Usage: nel deploy [options]

Run the deploy or release script in a project after checking that there are no local or remote changes.

Options:
  -h, --help  display help for command

```

### release

```
Usage: nel release [options]

Release project

Options:
  -h, --help  display help for command

```

### vc

Interactively choose a version control command.

```
Usage: nel vc [options] [command]

Options:
  -h, --help                   display help for command

Commands:
  branch [name]                Create a new branch
  checkout-pr|cpr              Checkout pull request
  delete-branches|d [options]  Delete local branches
  checkout|co [options]        Checkout branch

```

### branch

Create a new branch

```
Usage: nel branch [options] [name]

Interactively create a new branch linked to an existing jira issue or lets you create a new issue.

Options:
  -h, --help  display help for command

```

### checkout-pr

Checkout pull request

```
Usage: nel checkout-pr|cpr [options]

Interactively checkout a open pull request

Options:
  -h, --help  display help for command

```

### delete-branches

Delete local branches

```
Usage: nel delete-branches|d [options]

Interactively delete branches

Options:
  -y, --yes   Delete without confirmation.
  -h, --help  display help for command

```

### checkout

Checkout branch

```
Usage: nel checkout|co [options]

Interactively checkout a local or remote branch

Options:
  -r, --remote  List remote branches
  -h, --help    display help for command

```

### jira

Interactively choose a Jira command.

```
Usage: nel jira [options] [command]

Jira commands

Options:
  -h, --help     display help for command

Commands:
  close <key>    Closes the jira issue
  new [options]  Create a new jira issue through interactive prompts

```

### link

```
Usage: nel link [options] <package-names...>

Link ardoq package

Options:
  -w, --watch        Watch for changes in linked package
  -p, --path <path>  Relative path to ardoq packages (default:
                     "../ardoq-packages")
  -h, --help         display help for command

```

### unlink

```
Usage: nel unlink [options]

Unlink shared-ui package

Options:
  -h, --help  display help for command

```

### test

Test project

```
Usage: nel test [options]

Runs the test script in a project.

Options:
  -w, --watch  Watch tests if supported by the project
  -h, --help   display help for command

```

<!-- commands-end -->

## 📓 Logging

You can specify the log level for the `nel` command by setting the `NEL_LOG_LEVEL` environment variable. The default is `info`. Supported levels are `debug`, `info`, `warn`, and `error`.

Example:

```bash
$ NEL_LOG_LEVEL=debug nel
```

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