Getting Started

This guide will help you get started with MonoPKG by walking you through the installation process and providing you with some basic information on how to use it.

Installation

To install MonoPKG, you need to have Node.js version 18 or higher installed on your machine. You can also use Bun version 1 or higher to install MonoPKG.

Prerequisites

• Node.js version 18 or higher, or
• Bun version 1 or higher.

MonoPKG can be installed globally using Bun, NPM, or Yarn.

PNPM Support

Working with PNPM workspaces is not supported at the moment. PNPM workspace support will be added soon.

Installation Commands

Choose your preferred package manager and run the following command to install MonoPKG globally:

Bun

bun add -g monopkg

NPM

npm install -g monopkg

Yarn

yarn global add monopkg

Running MonoPKG

To run MonoPKG, you can use the following command:

Global

monopkg [command] [options]

Node Alias

mpkg [command] [options]

Bun Alias

bpkg [command] [options]

If you prefer not to install it globally, you can also run it using x commands. This allows you to execute MonoPKG commands without a global installation:

Bun

bun x monopkg [command] [options]

NPM

npm x monopkg [command] [options]

Yarn

yarn dlx monopkg [command] [options]

Verifying Installation

To verify that MonoPKG has been installed correctly, you can run the following command:

monopkg --version

This should display the version of MonoPKG that is installed.

Uninstalling MonoPKG

If you need to uninstall MonoPKG, you can do so using the following commands based on your package manager:

Bun

bun remove -g monopkg

NPM

npm uninstall -g monopkg

Yarn

yarn global remove monopkg

Getting Help

For more information on how to use MonoPKG, you can access the help documentation by running:

monopkg --help

This will provide you with a list of available commands and options.