CLI Init

The packship init command is the starting point for creating a new package with PackShip. This guide explains all the options and features of this command.

Basic Usage

To initialize a new package project, simply run:

packship init

If you haven't installed PackShip globally, you can use npx:

npx packship init

This will start an interactive setup process that guides you through configuring your package.

Command Options

The init command supports the following option:

--yes, -y

Skip all prompts and use default values.

packship init -y

Or with npx:

npx packship init -y

Using -y will create a package with default values. You'll need to manually edit the package.json file afterward to customize your package details.

Configuration Prompts

When running packship init without the -y flag, you'll be prompted to provide package creation information.

Examples

Quick Initialization with Defaults

packship init -y

Using npx for One-time Execution

npx packship init

NPM Authentication

publish