packshellDocs
HomeGitHubOpen app
Getting started

Installation

packshell ships as a single npm package that provides the packshell command-line tool.

Requirements

  • Node.js 20 or newer. Check with node --version.
  • A packshell account — created the first time you run packshell auth and sign in through the website.

Install globally

Installing globally puts packshell on your PATH so you can run it from any repository.

terminal
$ npm install -g packshell

Verify the installation:

terminal
$ packshell --version$ packshell --help

Use without installing

For one-off use or in CI you can run it directly with npx:

terminal
$ npx packshell pull --env production

Pointing at a custom API

By default the CLI talks to the hosted packshell API. If you run your own deployment, point the CLI at it with the PACKSHELL_API_URL environment variable or the --api flag on commands that support it.

terminal
# via environment variable$ export PACKSHELL_API_URL="https://packshell.your-company.com"# or per command$ packshell auth --api https://packshell.your-company.com
Self-hostingpackshell is a Next.js app plus a CLI in one repository. You can deploy the web/API side yourself and have your team's CLIs target it with PACKSHELL_API_URL.

Next step

With the CLI installed, head to the quickstart to connect your account and push your first encrypted environment.

← PreviousIntroduction