Getting Started: Installing the PinVPN CLI

This guide will walk you through the first steps of setting up the command-line interface for PinVPN, enabling you to manage your compliance workflows efficiently.

Prerequisites

Before you begin, ensure you have the following installed on your system:

Node.js (version 16 or higher)
An active PinVPN Pro account
Basic knowledge of command-line operations

Your API key will be required during the first use. You can find it in your account settings under 'API Access'.

Installation

To install the CLI, run the following command in your terminal:

npm install -g @pinvpn/cli

Make sure you have appropriate permissions to install global packages on your system.

Verifying Your Installation

After installation, verify that everything is working correctly by checking the version:

pinvpn --version

Pro tip: You can use pinvpn help to see all available commands and their usage.

Next Steps

Now that you have the CLI installed, you can:

Configure your environment - Set up your workspace and authentication details
Create your first project - Initialize a new compliance project
Explore commands - Learn about all available CLI commands

Ready to start your first project?

Follow our comprehensive guide to creating and managing your first compliance project.

Was this page helpful?

Edit this page on GitHub