chectl

Eclipse Che® CLI

Report issues

Issues are tracked on the main Eclipse Che® Repository: https://github.com/eclipse/che/issues

Installation
Updating
Usage
Commands
Contributing
Builds
SBOM
License
Trademark

Installation

There are two channels of chectl: stable and next

Stable is for all tagged versions of Eclipse Che®. Next is updated after each commit/Pull Request being merged in main branch of the Chectl repository.

If you're using Windows x64, here is how to install chectl by using one single PowerShell command:

For stable channel:

C:\Users> Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://che-incubator.github.io/chectl/install.ps1'))

For next channel:

C:\Users> $CHANNEL="next"; Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://che-incubator.github.io/chectl/install.ps1'))

If you're using linux or macOS, here is how to install chectl by using one single command:

For stable channel:

$ bash <(curl -sL  https://che-incubator.github.io/chectl/install.sh)

For next channel:

$ bash <(curl -sL  https://che-incubator.github.io/chectl/install.sh) --channel=next

Manual install:

Download a .tgz file based on your Operating System / Arch from https://github.com/che-incubator/chectl/releases
Unpack the assembly
Move chectl folder into a folder like $HOME/chectl
Add alias alias chectl=$HOME/chectl/bin/run

Updating

Download a .tgz file based on your Operating System / Arch from https://github.com/che-incubator/chectl/releases
Unpack the assembly into a local repository

CHECTL_VERSION=<DOWNLOADED_CHECTL_VERSION>
CHECTL_BINARIES=<DOWNLOADED_BINARIES_PATH>

CLIENT_DIR=${XDG_DATA_HOME:="$(cd && pwd)/.local/share"}/chectl/client/${CHECTL_VERSION}
mkdir ${CLIENT_DIR} -p
tar -xzf ${CHECTL_BINARIES} -C ${CLIENT_DIR} --strip-components=1

Update chectl from the local repository chectl update --from-local by prompting the downloaded version

Usage

$ chectl server:start
running command...

$ chectl server:stop
running command...

$ chectl --help [COMMAND]
USAGE
  $ chectl COMMAND
...

Commands

chectl autocomplete [SHELL]
chectl cacert:export
chectl commands
chectl dashboard:open
chectl help [COMMAND]
chectl server:debug
chectl server:delete
chectl server:deploy
chectl server:logs
chectl server:start
chectl server:status
chectl server:stop
chectl server:update
chectl update [CHANNEL]
chectl version

`chectl autocomplete [SHELL]`

display autocomplete installation instructions

USAGE
  $ chectl autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ chectl autocomplete

  $ chectl autocomplete bash

  $ chectl autocomplete zsh

  $ chectl autocomplete powershell

  $ chectl autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

`chectl cacert:export`

Retrieves Eclipse Che self-signed certificate

USAGE
  $ chectl cacert:export [-h] [-n <value>] [--telemetry on|off] [-d <value>]

FLAGS
  -d, --destination=<value>
      Destination where to store Eclipse Che self-signed CA certificate.
      If the destination is a file (might not exist), then the certificate will be saved there in PEM format.
      If the destination is a directory, then cheCA.crt file will be created there with Eclipse Che certificate in PEM
      format.
      If this option is omitted, then Eclipse Che certificate will be stored in a user's temporary directory as cheCA.crt.

  -h, --help
      Show CLI help.

  -n, --chenamespace=<value>
      Eclipse Che Kubernetes namespace.

  --telemetry=<option>
      Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
      <options: on|off>

DESCRIPTION
  Retrieves Eclipse Che self-signed certificate

See code: src/commands/cacert/export.ts

`chectl commands`

list all the commands

USAGE
  $ chectl commands [--json] [--deprecated] [-h] [--hidden] [--tree] [--columns <value> | -x] [--filter
    <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>]

FLAGS
  -h, --help         Show CLI help.
  -x, --extended     show extra columns
  --columns=<value>  only show provided columns (comma-separated)
  --csv              output is csv format [alias: --output=csv]
  --deprecated       show deprecated commands
  --filter=<value>   filter property by partial string matching, ex: name=foo
  --hidden           show hidden commands
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=<option>  output in a more machine friendly format
                     <options: csv|json|yaml>
  --sort=<value>     property to sort by (prepend '-' for descending)
  --tree             show tree of commands

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  list all the commands

See code: @oclif/plugin-commands

`chectl dashboard:open`

Open Eclipse Che dashboard

USAGE
  $ chectl dashboard:open [-h] [-n <value>] [--telemetry on|off]

FLAGS
  -h, --help                  Show CLI help.
  -n, --chenamespace=<value>  Eclipse Che Kubernetes namespace.
  --telemetry=<option>        Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
                              <options: on|off>

DESCRIPTION
  Open Eclipse Che dashboard

See code: src/commands/dashboard/open.ts

`chectl help [COMMAND]`

Display help for chectl.

USAGE
  $ chectl help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for chectl.

See code: @oclif/plugin-help

`chectl server:debug`

Enable local debug of Eclipse Che server

USAGE
  $ chectl server:debug [-h] [--debug-port <value>] [-n <value>] [--telemetry on|off]
    [--skip-kubernetes-health-check]

FLAGS
  -h, --help                      Show CLI help.
  -n, --chenamespace=<value>      Eclipse Che Kubernetes namespace.
  --debug-port=<value>            [default: 8000] Eclipse Che server debug port
  --skip-kubernetes-health-check  Skip Kubernetes health check
  --telemetry=<option>            Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
                                  <options: on|off>

DESCRIPTION
  Enable local debug of Eclipse Che server

See code: src/commands/server/debug.ts

`chectl server:delete`

delete any Eclipse Che related resource

USAGE
  $ chectl server:delete [-h] [-n <value>] [--delete-all] [--delete-namespace] [--telemetry on|off]
    [--skip-kubernetes-health-check] [-y | --batch]

FLAGS
  -h, --help                      Show CLI help.
  -n, --chenamespace=<value>      Eclipse Che Kubernetes namespace.
  -y, --yes                       Automatic yes to prompts; assume "yes" as answer to all prompts and run
                                  non-interactively
  --batch                         Batch mode. Running a command without end user interaction.
  --delete-all                    Indicates to delete Eclipse Che and Dev Workspace related resources
  --delete-namespace              Indicates that a Eclipse Che namespace will be deleted as well
  --skip-kubernetes-health-check  Skip Kubernetes health check
  --telemetry=<option>            Enable or disable telemetr

Chectl

Install / Use

README