nxpm

Looking for the full-stack generator?

➡️ Check here github.com/nxpm/stack

CLI to make the world-class nx workspace even more amazing!

nxpm.dev

• nxpm
• Usage
• Commands

nxpm plugins

Interactively install and remove plugins, run schematics from installed plugins.

nxpm projects

Interactively browse the projects in a workspace and run builders and schematics.

nxpm sandbox

Quickly spin up Docker based sandboxes with various NX presets installed.

Usage

$ npm install -g nxpm
$ nxpm COMMAND
running command...
$ nxpm (-v|--version|version)
nxpm/2.0.0 darwin-x64 node-v16.13.0
$ nxpm --help [COMMAND]
USAGE
  $ nxpm COMMAND
...

Commands

• nxpm config:delete
• nxpm config:edit
• nxpm config:get KEY
• nxpm config:set KEY VALUE
• nxpm help [COMMAND]
• nxpm plugins
• nxpm projects [PROJECTNAME] [TARGET]
• nxpm registry:disable
• nxpm registry:enable
• nxpm registry:start
• nxpm registry:status
• nxpm release [VERSION]
• nxpm sandbox [SANDBOXID] [ACTION]
• nxpm sandbox:pull

nxpm config:delete

Delete the config file

USAGE
  $ nxpm config:delete

OPTIONS
  -g, --global  (required) Global config
  -h, --help    show CLI help

See code: src/commands/config/delete.ts

nxpm config:edit

Edit the config file

USAGE
  $ nxpm config:edit

OPTIONS
  -g, --global  (required) Global config
  -h, --help    show CLI help

See code: src/commands/config/edit.ts

nxpm config:get KEY

describe the command here

USAGE
  $ nxpm config:get KEY

OPTIONS
  -g, --global  (required) Global config
  -h, --help    show CLI help

See code: src/commands/config/get.ts

nxpm config:set KEY VALUE

describe the command here

USAGE
  $ nxpm config:set KEY VALUE

OPTIONS
  -g, --global  (required) Global config
  -h, --help    show CLI help

See code: src/commands/config/set.ts

nxpm help [COMMAND]

display help for nxpm

USAGE
  $ nxpm help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

nxpm plugins

Install and remove community plugins

USAGE
  $ nxpm plugins

OPTIONS
  -c, --cwd=cwd  [default: /Users/beeman/nxpm/nxpm-cli] Current working directory
  -h, --help     show CLI help
  -r, --refresh  Refresh the list of plugins

ALIASES
  $ nxpm pl

See code: src/commands/plugins.ts

nxpm projects [PROJECTNAME] [TARGET]

Interactive menu to run builders and schematics for projects

USAGE
  $ nxpm projects [PROJECTNAME] [TARGET]

ARGUMENTS
  PROJECTNAME  The name of the project you want to operate on
  TARGET       The target to run (build, serve, test, etc)

OPTIONS
  -c, --cwd=cwd  [default: /Users/beeman/nxpm/nxpm-cli] Current working directory
  -h, --help     show CLI help

ALIASES
  $ nxpm p

See code: src/commands/projects.ts

nxpm registry:disable

Disable yarn and npm from using local npm registry

USAGE
  $ nxpm registry:disable

See code: src/commands/registry/disable.ts

nxpm registry:enable

Configure yarn and npm to use the local registry

USAGE
  $ nxpm registry:enable

See code: src/commands/registry/enable.ts

nxpm registry:start

Start local npm registry

USAGE
  $ nxpm registry:start

See code: src/commands/registry/start.ts

nxpm registry:status

Show yarn and npm registry configuration

USAGE
  $ nxpm registry:status

See code: src/commands/registry/status.ts

nxpm release [VERSION]

Release publishable packages in an Nx Workspace

USAGE
  $ nxpm release [VERSION]

ARGUMENTS
  VERSION  The version you want to release in semver format (eg: 1.2.3-beta.4)

OPTIONS
  -b, --build          Build libraries after versioning
  -c, --cwd=cwd        [default: /Users/beeman/nxpm/nxpm-cli] Current working directory
  -d, --dry-run        Dry run, don't make permanent changes
  -f, --fix            Automatically fix known issues
  -h, --help           show CLI help
  -i, --allow-ivy      Allow publishing Angular packages built for Ivy
  --ci                 CI mode (fully automatic release)
  --local              Release package to local registry
  --localUrl=localUrl  [default: http://localhost:4873/] URL to local registry

See code: src/commands/release.ts

nxpm sandbox [SANDBOXID] [ACTION]

Create a sandbox using Docker

USAGE
  $ nxpm sandbox [SANDBOXID] [ACTION]

ARGUMENTS
  SANDBOXID  The ID of the sandbox
  ACTION     Action to perform on sandbox

OPTIONS
  -c, --cwd=cwd        [default: /Users/beeman/nxpm/nxpm-cli] Current working directory
  -h, --help           show CLI help
  -r, --refresh        Refresh the list of plugins
  --port-api=port-api  [default: 3000] Port to open for the API app
  --port-web=port-web  [default: 4200] Port to open for the Web app
  --ports=ports        Comma-separated list of additional ports to open (eg: 8080, 10080:80)

See code: src/commands/sandbox.ts

nxpm sandbox:pull

Pull images of sandboxes

USAGE
  $ nxpm sandbox:pull

OPTIONS
  -f, --force    Force removal of the sandboxes
  -h, --help     show CLI help
  -m, --remove   Remove all of the sandboxes before pulling
  -r, --refresh  Refresh the list of sandboxes

See code: src/commands/sandbox/pull.ts