CLI Other

In addition to the core init, publish, and the version flag commands, PackShip provides several other useful commands. This guide explains these additional commands and their usage.

packship report

The report command allows you to report issues with the PackShip tool itself directly to the GitHub repository.

Basic Usage

packship report

This command will:

Guide you through an interactive process to report an issue
Allow you to choose between automatic or manual submission
Collect necessary information about the issue
Optionally include system information to help with troubleshooting

Submission Methods

Automatic Submission

Submit the issue directly to GitHub from the CLI. This requires a GitHub personal access token with the "repo" scope.

If you don't have a token configured, the CLI will prompt you to enter one and optionally save it for future use.

Manual Submission

The CLI will format your issue and provide instructions for manually submitting it to GitHub.

Issue Categories

You can report different types of issues:

Bug Report - For problems with the PackShip tool
Feature Request - For suggesting new features
Documentation Issue - For reporting errors or gaps in documentation
Question - For general questions about PackShip
Other - For any other PackShip-related issues

The report command is designed for reporting issues with the PackShip tool itself. If you suspect the PackShip CLI is causing problems with your npm package, you can either use packship report or submit an issue directly on our GitHub Issues page.

Telemetry Commands

PackShip collects anonymous usage data to help improve the tool. This data includes command usage and error rates, but never includes personal information or code. You can control telemetry with the following commands.

By default, telemetry is turned on when you first install and use PackShip. This helps us understand how the tool is being used and identify areas for improvement. You can disable it at any time using the commands below.

packship telemetry status

Check the current status of telemetry collection.

packship telemetry status

This will show whether telemetry is enabled or disabled.

Telemetry is currently enabled.

PackShip collects anonymous usage data to help improve the tool.
This data includes command usage and error rates, but never includes personal information or code.

packship telemetry enable

Enable telemetry collection.

packship telemetry enable

This will enable the collection of anonymous usage data.

Telemetry has been enabled.

packship telemetry disable

Disable telemetry collection.

packship telemetry disable

This will disable the collection of anonymous usage data.

Telemetry has been disabled.

Telemetry data is anonymous and does not include any personal information or code. It only includes information about which commands are used and basic system information to help improve the tool.

packship help

Display help information for PackShip commands.

# General help
packship help

# Command-specific help
packship help init
packship help publish
packship help report

This will show detailed information about the specified command, including available options and examples.

Version Flag