Using the chectl management tool

chectl is the Eclipse Che command-line management tool. It is used for operations on the Che server (start, stop, update, delete) and on workspaces (list, start, stop, inject) and to generate devfiles.

You can find additional information in the chectl README.

Installing the chectl management tool on Windows

This section describes how to install the chectl management tool on Windows.

Procedure
  • Run the following command in the PowerShell terminal:

    C:\Users> Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://www.eclipse.org/che/chectl/win/'))
Verification steps
  • The chectl tool is available at C:\ProgramData\chectl.

Installing the chectl management tool on Linux or macOS

This section describes how to install the chectl management tool on Linux or macOS.

Prerequisites
  • The directory /usr/local/bin is in the user $PATH.

  • The sudo command is configured for the current user.

  • No old or undesired versions of chectl present on the system.

Procedure
  1. Run the following command in the terminal (this downloads and executes the install.sh script):

    $ bash <(curl -sL  https://www.eclipse.org/che/chectl/)
  2. Run the following command to verify that the chectl tool is available at /usr/local/bin/chectl:

    $ which chectl
    /usr/local/bin/chectl
  3. Run the following command to verify that the version of chectl that is the expected one.

    $ chectl --version

    To identify the latest stable release, see the list of chectl releases and search for a release not containing "next" in the name.

  4. Read the installation logs.

    $ cat chectl-install.log

Upgrading the chectl management tool

This section describes how to upgrade the chectl management tool.

Procedure
  • Run the following command in the terminal to update chectl to the latest version.

    # chectl update

    The command updates chectl based on its current channel.

Two update channels are available for chectl: stable and next.

  • stable is for the latest released version of Eclipse Che.

  • next is updated after each activity in master branch of the chectl repository.

To move to a different channel, invoke the update with the name of the channel as an optional argument.

# chectl update [next|stable]