Skip to main content

Command Line Tools

Our command-line tool makes managing your Plane instance simple. You can handle installs, upgrades, and general management without needing to be a Docker expert.

Commercial Edition • Prime CLI​

note

If you are on the Community Edition and want to upgrade to the Commercial Edition, see Upgrade to Commercial Edition.

Prime CLI provides commands for common tasks like configuring services, monitoring health, managing backups, and upgrading your Plane instance.

Launch Prime CLI with sudo prime-cli from any directory on your machine.

Prime CLI Commands​

  • start — Starts a service in the Docker network

  • stop — Stops a service in the Docker network

  • restart — Restarts a service in the Docker network

  • monitor — Allows you to see if services are up or down and access their logs

  • healthcheck — Shows you the service status and errors, if any

  • repair — Automatically diagnoses and fixes common errors. This command also resets all configuration values in the plane.env file to their defaults.

  • update-cli — Downloads and installs the latest version of Prime CLI

    tip

    It is highly recommended to run update-cli before you download any Plane updates. The latest version of the CLI ensures your Plane upgrades happen smoothly.

  • configure — Brings up a step form to let you specify the following:

    Configuration steps

    • Listening port

      Specify the port that the built-in reverse proxy will use

      Default value: 80

    • Max file-upload size

      Specify a size in MBs for how big each file uploaded to your Plane app can be

      Default value: 5 MB

    • External Postgres URL

      Specify the URL of your own hosted Postgres if you would like to change the database your Plane app uses.

      Default database: Postgres 15.5 in the Docker container

    • External Redis URL

      Specify the URL of your own hosted Redis if you would like to change the default Redis Plane ships with.

      Default Redis: Redis 7.2.4

    • External storage

      Specify your AWS S3 bucket's credentials in the format below to change storage from the default Plane ships with.

      • AWS Access Key ID

      • AWS Secret Access Key

      • AWS S3 Bucket Name

        Default storage: MinIO

      • Confirm your choices on the screen ↓.

        This restarts your instance with the new configs.

  • upgrade — Checks your instance for available version upgrades. You will be asked for confirmation before downloading the latest available version.

    1. Typing YES lets the CLI automatically download the latest version and installs it. Then it restarts the instance to load the latest app.
    2. Typing NO cancels the upgrade.

  • uninstall — Uninstalls Plane. Before continuing, you are asked for confirmation.

    1. Typing YES lets the CLI clean up the /opt/plane folder, leaving behind the /opt/plane/data and /opt/plane/logs folders.
    2. Typing NO cancels the uninstall.

Troubleshoot​

Community Edition • setup.sh​

The setup script setup.sh provides a menu-driven interface to help you install and manage your Plane Community Edition instance.

Usage​

To run the setup.sh script, use the following command in your terminal from the directory where the script is located:

./setup.sh

This will launch an interactive menu with options to manage various aspects of your Plane instance.

Select an action you want to perform:
   1) Install
   2) Start
   3) Stop
   4) Restart
   5) Upgrade
   6) View Logs
   7) Backup Data
   8) Exit

Actions​

  • Install Installs the Plane Community Edition on your machine. Choose this option if you are setting up Plane for the first time.

  • Start Starts the Plane server and all related services.

  • Stop Stops the Plane server and all services currently running on the machine.

  • Restart Restarts the Plane server and all associated services.

  • Upgrade Upgrades Plane to the latest available version. This will stop all services, update the necessary files, and then restart Plane with the latest configuration. See Update Plane for more info.

    warning

    It’s recommended to create a backup before upgrading your instance. See Backup and restore.

  • View Logs Displays real-time logs of specific Plane services. See View logs for more info.

    tip

    Use View Logs to monitor service performance or troubleshoot issues. Press CTRL+C to exit the log view and return to the main menu.

  • Backup Data Creates a backup of your current Plane installation, including all data. See Backup and restore data for more info.

  • Exit Closes the setup script and returns you to the command line.