@nandu/cli

Nandu CLI

Nandu Open NPM Registry CLI

• Nandu CLI
• Quick Start
• Teams
• Usage
• Commands

Quick Start

In order to quickly get a working Nandu NPM registry you can follow this steps and recommendations.

Nandu uses env variables for configuring all its settings, inclusive the ROOT user credentials. The root user is the one that can bootstrap the service, by creating new users and so on. Also the root user has godlike permissions, therefore it is important to only use it for bootstrapping, and the first thing to do is to create a new user and give it "admin" permissions.

When you start Nandu for the first time it will create such root user that you can then use to interact with the registry.

$ nandu start
Nandu is running on port 4567.

You will get a lot of debug logs unless you set NODE_ENV to production.

By default Nandu will use Sqlite for storing the registry metadata, and the database file will be stored at ./storage/db/nandu.db. You can change this setting with the NANDU_SEQUELIZE_URI env variable.

The next step is to create an authentication token for the root user, you need to use the nandu cli for this as well,

$ nandu token:create root
username: root
password: ******

New token created for user root {
  id: 'ad4ac909-2cea-40ba-be4e-03ec4fbb57bf',
  token: 'c0463461-23fb-4642-a927-820b0d71ffb8',
  readonly: false,
  created: '2021-11-11T08:09:47.532Z'
}

You can create tokens on behalf of other users if the user you use for creating the tokens has the correct permissions.

Teams

Nandu support many of the advanced features of the NPM registry, such as teams, scopes, and more. So you will most likely interact with your Nandu server using the standard (NPM CLI)[https://docs.npmjs.com/cli/v8]

Lets take for example the case we want to create a team, add a user to said team and then give read access to a given package that is part of that team.

Start by adding a team:

$ npm team add myorg:myteam

We have now created a team inside the org/scope "myorg". You can see the list of teams by running:

$ npm team ls

Now we want to add a package to said team:

$ npm access grant read-only  @myorg:myteam @myorg/mypackage

Usage

$ npm install -g @nandu/cli
$ nandu COMMAND
running command...
$ nandu (--version)
@nandu/cli/1.0.0 linux-x64 node-v20.19.1
$ nandu --help [COMMAND]
USAGE
  $ nandu COMMAND
...

Commands

• nandu start
• nandu token
• nandu token:create USER
• nandu token:ls USER
• nandu user
• nandu user:add USER

nandu start

Starts Nandu Open NPM Server

USAGE
  $ nandu start [-h] [-p <value>] [-f]

FLAGS
  -f, --force
  -h, --help          Show CLI help.
  -p, --port=<value>  [default: 4567] listen to port

DESCRIPTION
  Starts Nandu Open NPM Server

EXAMPLES
  $ nandu start -p 4567

See code: src/commands/start.ts

nandu token

Manage NPM Registry tokens

USAGE
  $ nandu token

DESCRIPTION
  Manage NPM Registry tokens

EXAMPLES
  $ nandu token:create myuser

See code: src/commands/token/index.ts

nandu token:create USER

create a new token for given user

USAGE
  $ nandu token:create USER --registry <value> [-h] [--token <value> | ] [--readonly] [--cidr-whitelist <value>]

FLAGS
  -h, --help                    Show CLI help.
      --cidr-whitelist=<value>  comma separated list of whitelisted cidrs
      --readonly                generate a readonly token
      --registry=<value>        (required) URI pointing to your Nandu NPM Registry
      --token=<value>           Token to be used for authentication, uses NPM_TOKEN env variable if unspecified

DESCRIPTION
  create a new token for given user

EXAMPLES
  $ nandu start -p 4567

See code: src/commands/token/create.ts

nandu token:ls USER

list tokens for given user

USAGE
  $ nandu token:ls USER --registry <value> [-h] [--token <value> | ]

FLAGS
  -h, --help              Show CLI help.
      --registry=<value>  (required) URI pointing to your Nandu NPM Registry
      --token=<value>     Token to be used for authentication, uses NPM_TOKEN env variable if unspecified

DESCRIPTION
  list tokens for given user

EXAMPLES
  $ nandu start -p 4567

See code: src/commands/token/ls.ts

nandu user

Manage NPM Registry users

USAGE
  $ nandu user

DESCRIPTION
  Manage NPM Registry users

EXAMPLES
  $ nandu user:add myuser

See code: src/commands/user/index.ts

nandu user:add USER

add or update a new token for given user

USAGE
  $ nandu user:add USER --registry <value> [-h] [--token <value> | ]

FLAGS
  -h, --help              Show CLI help.
      --registry=<value>  (required) URI pointing to your Nandu NPM Registry
      --token=<value>     Token to be used for authentication, uses NPM_TOKEN env variable if unspecified

DESCRIPTION
  add or update a new token for given user

EXAMPLES
  $ nandu user:add myuser

See code: src/commands/user/add.ts