Prerequisites

Before you start using PackShip, make sure you have the following prerequisites installed and configured on your system.

System Requirements

As of March 2025, PackShip requires the following minimum software to be installed on your system:

• Node.js (version 20.x or higher)
• npm (version 9.x or higher)

Operating System Compatibility

PackShip is cross-platform and works on:

• Windows
• macOS
• Linux

While PackShip can run on these minimum requirements, we recommend using:

• Node.js (version 22.x or higher) for optimal performance
• npm (version 10.x or higher) for improved dependency resolution

Hardware Requirements

PackShip is lightweight and has minimal hardware requirements:

• Disk Space: Minimal space required for the CLI tool itself. Additional space will be needed for your project dependencies.
• Internet Connection: Required for installing dependencies and publishing packages

Installing Node.js and npm

You can download and install Node.js and npm from the official Node.js website.

To verify that Node.js and npm are installed correctly, run the following commands in your terminal:

node --version

npm --version

Installing PackShip CLI

Once you have Node.js and npm set up, you can install the PackShip CLI tool globally on your machine:

sudo npm i -g packship@latest

npm i -g packship@latest

This will install the PackShip command suite on your machine, making the packship command available globally.

To verify that PackShip is installed correctly, run:

packship --version

Development Environment

While not strictly required, we recommend using a code editor with good TypeScript support, such as:

• Visual Studio Code (recommended)
• WebStorm

npm Account

To publish packages, you'll need an npm account. If you don't have one already, you can create one at npmjs.com.

After creating an account, you'll need to log in via the command line:

npm login