Skip to main content

xpm

Synopsis

xpm <command> [<subcommand>...] [<options> ...] [<args>...]

Description

xpm is the xPacks project manager. It handles dependencies and places packages in designated locations, ensuring that builds can locate them efficiently.

info

xpm is an extension of npm and uses the same public registry at https://registry.npmjs.org."

The programme accepts a command name, potentially accompanied by one or more subcommand names, options (which begin with a dash), and possibly one or more arguments, such as names or files.

The list of accepted options and arguments is specific to a given command or set of commands and subcommands.

Common options

Help (-h|--help)

To gain an initial understanding of the programme, request help:

% xpm --help

The xPack project manager command line tool
Usage: xpm <command> [<subcommand>...] [<options> ...] [<args>...]

where <command> is one of:
init, install, link, list, run, uninstall

Common options:
  --loglevel <level> Set log level (silent|warn|info|verbose|debug|trace)
  -s|--silent Disable all messages (--loglevel silent)
  -q|--quiet Mostly quiet, warnings and errors (--loglevel warn)
  --informative Informative (--loglevel info)
  -v|--verbose Verbose (--loglevel verbose)
  -d|--debug Debug messages (--loglevel debug)
  -dd|--trace Trace messages (--loglevel trace, -d -d)
  --no-update-notifier Skip check for a more recent version
  -C <folder> Set current folder

xpm -h|--help Quick help
xpm <command> -h|--help Quick help on command
xpm --version Show version
xpm -i|--interactive Enter interactive mode

npm xpm@0.20.8 '/Users/ilg/.nvm/versions/node/v20.18.0/lib/node_modules/xpm'
Home page: <https://xpack.github.io/xpm-preview/>
Bug reports: <https://github.com/xpack/xpm-js/issues>

This functions both at top level and with commands/subcommands.

Log level (--loglevel)

The default behaviour of the program is to display only a minimum amount of messages.

This can be adjusted, ranging from not displaying any messages at all (--silent) to displaying numerous debugging trace messages (--trace).

  --loglevel <level>     Set log level (silent|warn|info|verbose|debug|trace)
  -s|--silent Disable all messages (--loglevel silent)
  -q|--quiet Mostly quiet, warnings and errors (--loglevel warn)
  --informative Informative (--loglevel info)
  -v|--verbose Verbose (--loglevel verbose)
  -d|--debug Debug messages (--loglevel debug)
  -dd|--trace Trace messages (--loglevel trace, -d -d)

Current folder (-C)

By default, the program is executed within the context of the current shell folder> However, this can be changed to any folder using -C <folder>.

Program version (--version)

As with most command line tools, it is possible to request the current version, with --version:

% xpm --version
0.20.8

The result is written to the standard output stream and consists of the semver string, without any v prefix. This allows it to be directly used in automated scripts without any post-processing.

Skip checks (--no-update-notifier)

By default, before exiting, xpm checks once a day if a new version of the programme is available.

For environments where this check is not necessary, it can be disabled.

Interactive mode (-i|--interactive)

The common use case is to start the program for each single command.

It is also possible to start the program with a prompt, and issue as many commands as needed.

% xpm -i
xpm> version
0.20.8
xpm>
...

Commands