chectl

Report issues

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

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://www.eclipse.org/che/chectl/win/'))

For next channel:

C:\Users> $CHANNEL="next"; Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://www.eclipse.org/che/chectl/win/'))

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://www.eclipse.org/che/chectl/)

For next channel:

$ bash <(curl -sL  https://www.eclipse.org/che/chectl/) --channel=next

Assemblies of chectl are available at https://github.com/che-incubator/chectl/releases

Manual install:

Download a .tgz file based on your Operating System / Arch
Unpack the assembly
Move chectl folder into a folder like $HOME/chectl
Add alias alias chectl=$HOME/chectl/bin/run

Usage

$ chectl server:start
running command...

$ chectl server:stop
running command...

$ chectl workspace:start --devfile
running command...

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

Commands

chectl auth:delete CHE-API-ENDPOINT
chectl auth:get
chectl auth:list
chectl auth:login [CHE-API-ENDPOINT]
chectl auth:logout
chectl auth:use [CHE-API-ENDPOINT]
chectl autocomplete [SHELL]
chectl cacert:export
chectl dashboard:open
chectl devfile:generate
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 workspace:create
chectl workspace:delete WORKSPACE
chectl workspace:inject
chectl workspace:list
chectl workspace:logs
chectl workspace:start WORKSPACE
chectl workspace:stop WORKSPACE

`chectl auth:delete CHE-API-ENDPOINT`

Delete specified login session(s)

USAGE
  $ chectl auth:delete CHE-API-ENDPOINT

ARGUMENTS
  CHE-API-ENDPOINT  Eclipse Che server API endpoint

OPTIONS
  -h, --help               show CLI help
  -u, --username=username  Eclipse Che username
  --telemetry=on|off       Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

EXAMPLES
  # Delete login session of the specified user on the cluster:
  chectl auth:delete che-che.apps-crc.testing/api -u username


  # Delete all login sessions on the cluster:
  chectl auth:delete che-che.apps-crc.testing

See code: src/commands/auth/delete.ts

`chectl auth:get`

Display active login session

USAGE
  $ chectl auth:get

OPTIONS
  -h, --help          show CLI help
  --telemetry=on|off  Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/auth/get.ts

`chectl auth:list`

Show all existing login sessions

USAGE
  $ chectl auth:list

OPTIONS
  -h, --help          show CLI help
  --telemetry=on|off  Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/auth/list.ts

`chectl auth:login [CHE-API-ENDPOINT]`

Log in to Eclipse Che server

USAGE
  $ chectl auth:login [CHE-API-ENDPOINT]

ARGUMENTS
  CHE-API-ENDPOINT  Eclipse Che server API endpoint

OPTIONS
  -h, --help                         show CLI help
  -n, --chenamespace=chenamespace    Eclipse Che Kubernetes namespace. Default to 'eclipse-che'
  -p, --password=password            Eclipse Che user password
  -t, --refresh-token=refresh-token  Keycloak refresh token
  -u, --username=username            Eclipse Che username
  --telemetry=on|off                 Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

EXAMPLES
  # Log in with username and password (when OpenShift OAuth is not enabled):
  chectl auth:login https://che-che.apps-crc.testing/api -u username -p password


  # Log in with username and password (password will be asked interactively):
  chectl auth:login che-che.apps-crc.testing -u username


  # Log in with token (when OpenShift OAuth is enabled):
  chectl auth:login che.openshift.io -t token


  # Log in with oc token (when logged into an OpenShift cluster with oc and OpenShift OAuth is enabled):
  chectl auth:login che.my.server.net

See code: src/commands/auth/login.ts

`chectl auth:logout`

Log out of the active login session

USAGE
  $ chectl auth:logout

OPTIONS
  -h, --help          show CLI help
  --telemetry=on|off  Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/auth/logout.ts

`chectl auth:use [CHE-API-ENDPOINT]`

Set active login session

USAGE
  $ chectl auth:use [CHE-API-ENDPOINT]

ARGUMENTS
  CHE-API-ENDPOINT  Eclipse Che server API endpoint

OPTIONS
  -h, --help               show CLI help
  -i, --interactive        Select an active login session in interactive mode
  -u, --username=username  Eclipse Che username
  --telemetry=on|off       Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

EXAMPLES
  # Set an active login session for the specified user on the given cluster:
  chectl auth:use che-che.apps-crc.testing/api -u username


  # Switch to another user on the same cluster:
  chectl auth:use -u another-user-on-this-server


  # Switch to the only user on the given cluster:
  chectl auth:use my.cluster.net


  # Select an active login session in interactive mode:
  chectl auth:use -i

See code: src/commands/auth/use.ts

`chectl autocomplete [SHELL]`

display autocomplete installation instructions

USAGE
  $ chectl autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

EXAMPLES
  $ chectl autocomplete
  $ chectl autocomplete bash
  $ chectl autocomplete zsh
  $ chectl autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

`chectl cacert:export`

Retrieves Eclipse Che self-signed certificate

USAGE
  $ chectl cacert:export

OPTIONS
  -d, --destination=destination
      Destination where to store 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 Che 
      certificate in PEM format.
                           If this option is omitted, then Che certificate will be stored in a user's temporary directory 
      as cheCA.crt.

  -h, --help
      show CLI help

  -n, --chenamespace=chenamespace
      Eclipse Che Kubernetes namespace. Default to 'eclipse-che'

  --skip-kubernetes-health-check
      Skip Kubernetes health check

  --telemetry=on|off
      Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

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

`chectl dashboard:open`

Open Eclipse Che dashboard

USAGE
  $ chectl dashboard:open

OPTIONS
  -h, --help                       show CLI help
  -n, --chenamespace=chenamespace  Eclipse Che Kubernetes namespace. Default to 'eclipse-che'
  --telemetry=on|off               Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

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

`chectl devfile:generate`

generate and print a devfile to stdout given some Kubernetes resources and other workspaces features (project, language-support, commands etc...)

USAGE
  $ chectl devfile:generate

OPTIONS
  -h, --help                 show CLI help
  --command=command          Command to include in the workspace
  --dockerimage=dockerimage  dockerimage component to include in the Devfile
  --editor=editor            Specify the editor component. Currently supported editors: theia-next,theia-1.0.0
  --git-repo=git-repo        Source code git repository to include in the workspace

  --language=language        Add support for a particular language. Currently supported languages:
                             java,typescript,go,python,c#

  --name=name                Workspace name

  --namespace=namespace      Kubernetes namespace where the resources are defined

  --plugin=plugin            Eclipse Che plugin to include in the workspace. The format is JSON. For example this is a
                             valid Eclipse Che plugin specification: {"type": "TheEndpointName.ChePlugin", "alias":
                             "java-ls", "id": "redhat/java/0.38.0"}

  --selector=selector        label selector to filter the Kubernetes resources. For example
                             --selector="app.kubernetes.io/name=employee-manager"

  --telemetry=on|off         Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/devfile/generate.ts

`chectl help [COMMAND]`

display help for chectl

USAGE
  $ chectl help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`chectl server:debug`

Enable local debug of Eclipse Che server

USAGE
  $ chectl server:debug

OPTIONS
  -h, --help                       show CLI help
  -n, --chenamespace=chenamespace  Eclipse Che Kubernetes namespace. Default to 'eclipse-che'
  --debug-port=debug-port          [default: 8000] Eclipse Che server debug port
  --skip-kubernetes-health-check   Skip Kubernetes health check
  --telemetry=on|off               Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

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

`chectl server:delete`

delete any Eclipse Che related resource: Kubernetes/OpenShift/Helm

USAGE
  $ chectl server:delete

OPTIONS
  -h, --help                         show CLI help
  -n, --chenamespace=chenamespace    Eclipse Che Kubernetes namespace. Default to 'eclipse-che'

  -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-namespace                 Indicates that a Eclipse Che namespace will be deleted as well

  --deployment-name=deployment-name  [default: che] Eclipse Che deployment name

  --skip-kubernetes-health-check     Skip Kubernetes health check

  --telemetry=on|off                 Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

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

`chectl server:deploy`

Deploy Eclipse Che server

USAGE
  $ chectl server:deploy

OPTIONS
  -a, --installer=helm|operator|olm
      Installer type. If not set, default is "olm" for OpenShift 4.x platform otherwise "operator".

  -b, --domain=domain
      Domain of the Kubernetes cluster (e.g. example.k8s-cluster.com or <local-ip>.nip.io)
                           This flag makes sense only for Kubernetes family infrastructures and will be autodetected for 
      Minikube and MicroK8s in most cases.
                           However, for Kubernetes cluster it is required to specify.
                           Please note, that just setting this flag will not likely work out of the box.
                           According changes should be done in Kubernetes cluster configuration as well.
                           In case of Openshift, domain adjustment should be done on the cluster configuration level.

  -d, --directory=directory
      Directory to store logs into

  -h, --help
      show CLI help

  -i, --cheimage=cheimage
      Eclipse Che server container image

  -m, --multiuser
      Starts Eclipse Che in multi-user mode

  -n, --chenamespace=chenamespace
      Eclipse Che Kubernetes namespace. Default to 'eclipse-che'

  -o, --cheboottimeout=cheboottimeout
      (required) [default: 40000] Eclipse Che server bootstrap timeout (in milliseconds)

  -p, --platform=minikube|minishift|k8s|openshift|microk8s|docker-desktop|crc
      Type of Kubernetes platform. Valid values are "minikube", "minishift", "k8s (for kubernetes)", "openshift", "crc 
      (for CodeReady Containers)", "microk8s".

  -t, --templates=templates
      Path to the templates folder

  -v, --version=version
      Version to deploy (e.g. 7.15.2). Defaults to the same as chectl.

  --[no-]auto-update
      Auto update approval strategy for installation Eclipse Che.
                           With this strategy will be provided auto-update Eclipse Che without any human interaction.
                           By default this flag is enabled.
                           This parameter is used only when the installer is 'olm'.

  --batch
      Batch mode. Running a command without end user interaction.

  --catalog-source-name=catalog-source-name
      OLM catalog source to install Eclipse Che operator.
                           This parameter is used only when the installer is the 'olm'.

  --catalog-source-namespace=catalog-source-namespace
      Namespace for OLM catalog source to install Eclipse Che operator.
                           This parameter is used only when the installer is the 'olm'.

  --catalog-source-yaml=catalog-source-yaml
      Path to a yaml file that describes custom catalog source for installation Eclipse Che operator.
                           Catalog source will be applied to the namespace with Che operator.
                           Also you need define 'olm-channel' name and 'package-manifest-name'.
                           This parameter is used only when the installer is the 'olm'.

  --che-operator-cr-patch-yaml=che-operator-cr-patch-yaml
      Path to a yaml file that overrides the default values in CheCluster CR used by the operator. This parameter is used 
      only when the installer is the 'operator' or the 'olm'.

  --che-operator-cr-yaml=che-operator-cr-yaml
      Path to a yaml file that defines a CheCluster used by the operator. This parameter is used only when the installer 
      is the 'operator' or the 'olm'.

  --che-operator-image=che-operator-image
      Container image of the operator. This parameter is used only when the installer is the operator

  --debug
      Enables the debug mode for Eclipse Che server. To debug Eclipse Che server from localhost use 'server:debug' 
      command.

  --deployment-name=deployment-name
      [default: che] Eclipse Che deployment name

  --dev-workspace-controller-namespace=dev-workspace-controller-namespace
      [default: devworkspace-controller] Namespace for the DevWorkspace controller.  This parameter is used only when the 
      workspace engine is the DevWorkspace

  --devfile-registry-url=devfile-registry-url
      The URL of the external Devfile registry.

  --helm-patch-yaml=helm-patch-yaml
      Path to yaml file with Helm Chart values patch.
                           The file format is identical to values.yaml from the chart.
                           Note, Provided command line arguments take precedence over patch file.

  --k8spoddownloadimagetimeout=k8spoddownloadimagetimeout
      [default: 600000] Waiting time for Pod downloading image (in milliseconds)

  --k8spoderrorrechecktimeout=k8spoderrorrechecktimeout
      [default: 15000] Waiting time for Pod rechecking error (in milliseconds)

  --k8spodreadytimeout=k8spodreadytimeout
      [default: 600000] Waiting time for Pod Ready condition (in milliseconds)

  --k8spodwaittimeout=k8spodwaittimeout
      [default: 600000] Waiting time for Pod scheduled condition (in milliseconds)

  --olm-channel=olm-channel
      Olm channel to install Eclipse Che, f.e. stable.
                           If options was not set, will be used default version for package manifest.
                           This parameter is used only when the installer is the 'olm'.

  --[no-]olm-suggested-namespace
      Indicate to deploy Eclipse Che in OLM suggested namespace: 'eclipse-che'.
                           Flag 'chenamespace' is ignored in this case
                           This parameter is used only when the installer is 'olm'.

  --package-manifest-name=package-manifest-name
      Package manifest name to subscribe to Eclipse Che OLM package manifest.
                           This parameter is used only when the installer is the 'olm'.

  --plugin-registry-url=plugin-registry-url
      The URL of the external plugin registry.

  --postgres-pvc-storage-class-name=postgres-pvc-storage-class-name
      persistent volume storage class name to use to store Eclipse Che postgres database

  --skip-cluster-availability-check
      Skip cluster availability check. The check is a simple request to ensure the cluster is reachable.

  --skip-kubernetes-health-check
      Skip Kubernetes health check

  --skip-version-check
      Skip minimal versions check.

  --starting-csv=starting-csv
      Starting cluster service version(CSV) for installation Eclipse Che.
                           Flags uses to set up start installation version Che.
                           For example: 'starting-csv' provided with value 'eclipse-che.v7.10.0' for stable channel.
                           Then OLM will install Eclipse Che with version 7.10.0.
                           Notice: this flag will be ignored with 'auto-update' flag. OLM with auto-update mode installs 
      the latest known version.
                           This parameter is used only when the installer is 'olm'.

  --telemetry=on|off
      Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

  --workspace-engine=che-server|dev-workspace
      [default: che-server] Workspace Engine. If not set, default is "che-server". "dev-workspace" is experimental.

  --workspace-pvc-storage-class-name=workspace-pvc-storage-class-name
      persistent volume(s) storage class name to use to store Eclipse Che workspaces data

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

`chectl server:logs`

Collect Eclipse Che logs

USAGE
  $ chectl server:logs

OPTIONS
  -d, --directory=directory          Directory to store logs into
  -h, --help                         show CLI help
  -n, --chenamespace=chenamespace    Eclipse Che Kubernetes namespace. Default to 'eclipse-che'
  --deployment-name=deployment-name  [default: che] Eclipse Che deployment name
  --skip-kubernetes-health-check     Skip Kubernetes health check
  --telemetry=on|off                 Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

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

`chectl server:start`

Start Eclipse Che server

USAGE
  $ chectl server:start

OPTIONS
  -d, --directory=directory                                Directory to store logs into
  -h, --help                                               show CLI help
  -n, --chenamespace=chenamespace                          Eclipse Che Kubernetes namespace. Default to 'eclipse-che'
  --deployment-name=deployment-name                        [default: che] Eclipse Che deployment name

  --k8spoddownloadimagetimeout=k8spoddownloadimagetimeout  [default: 600000] Waiting time for Pod downloading image (in
                                                           milliseconds)

  --k8spoderrorrechecktimeout=k8spoderrorrechecktimeout    [default: 15000] Waiting time for Pod rechecking error (in
                                                           milliseconds)

  --k8spodreadytimeout=k8spodreadytimeout                  [default: 600000] Waiting time for Pod Ready condition (in
                                                           milliseconds)

  --k8spodwaittimeout=k8spodwaittimeout                    [default: 600000] Waiting time for Pod scheduled condition
                                                           (in milliseconds)

  --skip-kubernetes-health-check                           Skip Kubernetes health check

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

`chectl server:status`

Status Eclipse Che server

USAGE
  $ chectl server:status

OPTIONS
  -h, --help                       show CLI help
  -n, --chenamespace=chenamespace  Eclipse Che Kubernetes namespace. Default to 'eclipse-che'
  --telemetry=on|off               Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

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

`chectl server:stop`

stop Eclipse Che server

USAGE
  $ chectl server:stop

OPTIONS
  -h, --help
      show CLI help

  -n, --chenamespace=chenamespace
      Eclipse Che Kubernetes namespace. Default to 'eclipse-che'

  --access-token=access-token
      Eclipse Che OIDC Access Token. See the documentation how to obtain token: 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-keycloak_
      authenticating-to-the-che-server and 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-openshift
      -token-through-keycloak_authenticating-to-the-che-server.

  --che-selector=che-selector
      [default: app=che,component=che] Selector for Eclipse Che server resources

  --deployment-name=deployment-name
      [default: che] Eclipse Che deployment name

  --skip-kubernetes-health-check
      Skip Kubernetes health check

  --telemetry=on|off
      Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

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

`chectl server:update`

Update Eclipse Che server.

USAGE
  $ chectl server:update

OPTIONS
  -h, --help                                               show CLI help
  -n, --chenamespace=chenamespace                          Eclipse Che Kubernetes namespace. Default to 'eclipse-che'
  -t, --templates=templates                                Path to the templates folder

  -v, --version=version                                    Version to deploy (e.g. 7.15.2). Defaults to the same as
                                                           chectl.

  -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.

  --che-operator-cr-patch-yaml=che-operator-cr-patch-yaml  Path to a yaml file that overrides the default values in
                                                           CheCluster CR used by the operator. This parameter is used
                                                           only when the installer is the 'operator' or the 'olm'.

  --deployment-name=deployment-name                        [default: che] Eclipse Che deployment name

  --skip-kubernetes-health-check                           Skip Kubernetes health check

  --telemetry=on|off                                       Enable or disable telemetry. This flag skips a prompt and
                                                           enable/disable telemetry

EXAMPLES
  # Update Eclipse Che:
  chectl server:update

  # Update Eclipse Che in 'eclipse-che' namespace:
  chectl server:update -n eclipse-che

  # Update Eclipse Che and update its configuration in the custom resource:
  chectl server:update --che-operator-cr-patch-yaml patch.yaml

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

`chectl update [CHANNEL]`

update the chectl CLI

USAGE
  $ chectl update [CHANNEL]

See code: @oclif/plugin-update

`chectl workspace:create`

Creates a workspace from a devfile

USAGE
  $ chectl workspace:create

OPTIONS
  -d, --debug
      Debug workspace start. It is useful when workspace start fails and it is needed to print more logs on startup. This 
      flag is used in conjunction with --start flag.

  -f, --devfile=devfile
      Path or URL to a valid devfile

  -h, --help
      show CLI help

  -n, --chenamespace=chenamespace
      Eclipse Che Kubernetes namespace. Default to 'eclipse-che'

  -s, --start
      Starts the workspace after creation

  --access-token=access-token
      Eclipse Che OIDC Access Token. See the documentation how to obtain token: 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-keycloak_
      authenticating-to-the-che-server and 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-openshift
      -token-through-keycloak_authenticating-to-the-che-server.

  --che-api-endpoint=che-api-endpoint
      Eclipse Che server API endpoint

  --name=name
      Workspace name: overrides the workspace name to use instead of the one defined in the devfile.

  --skip-kubernetes-health-check
      Skip Kubernetes health check

  --telemetry=on|off
      Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/workspace/create.ts

`chectl workspace:delete WORKSPACE`

Delete a stopped workspace - use workspace:stop to stop the workspace before deleting it

USAGE
  $ chectl workspace:delete WORKSPACE

ARGUMENTS
  WORKSPACE  The workspace id to delete

OPTIONS
  -h, --help
      show CLI help

  -n, --chenamespace=chenamespace
      Eclipse Che Kubernetes namespace. Default to 'eclipse-che'

  --access-token=access-token
      Eclipse Che OIDC Access Token. See the documentation how to obtain token: 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-keycloak_
      authenticating-to-the-che-server and 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-openshift
      -token-through-keycloak_authenticating-to-the-che-server.

  --che-api-endpoint=che-api-endpoint
      Eclipse Che server API endpoint

  --delete-namespace
      Indicates that a Kubernetes namespace where workspace was created will be deleted as well

  --skip-kubernetes-health-check
      Skip Kubernetes health check

  --telemetry=on|off
      Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/workspace/delete.ts

`chectl workspace:inject`

Inject configurations and tokens in a workspace

USAGE
  $ chectl workspace:inject

OPTIONS
  -c, --container=container
      The container name. If not specified, configuration files will be injected in all containers of the workspace pod

  -h, --help
      show CLI help

  -k, --kubeconfig
      (required) Inject the local Kubernetes configuration

  -n, --chenamespace=chenamespace
      Eclipse Che Kubernetes namespace. Default to 'eclipse-che'

  -w, --workspace=workspace
      The workspace id to inject configuration into. It can be omitted if the only one running workspace exists.
                           Use workspace:list command to get all workspaces and their statuses.

  --access-token=access-token
      Eclipse Che OIDC Access Token. See the documentation how to obtain token: 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-keycloak_
      authenticating-to-the-che-server and 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-openshift
      -token-through-keycloak_authenticating-to-the-che-server.

  --che-api-endpoint=che-api-endpoint
      Eclipse Che server API endpoint

  --kube-context=kube-context
      Kubeconfig context to inject

  --skip-kubernetes-health-check
      Skip Kubernetes health check

  --telemetry=on|off
      Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/workspace/inject.ts

`chectl workspace:list`

List workspaces

USAGE
  $ chectl workspace:list

OPTIONS
  -h, --help
      show CLI help

  -n, --chenamespace=chenamespace
      Eclipse Che Kubernetes namespace. Default to 'eclipse-che'

  --access-token=access-token
      Eclipse Che OIDC Access Token. See the documentation how to obtain token: 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-keycloak_
      authenticating-to-the-che-server and 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-openshift
      -token-through-keycloak_authenticating-to-the-che-server.

  --che-api-endpoint=che-api-endpoint
      Eclipse Che server API endpoint

  --skip-kubernetes-health-check
      Skip Kubernetes health check

  --telemetry=on|off
      Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/workspace/list.ts

`chectl workspace:logs`

Collect workspace(s) logs

USAGE
  $ chectl workspace:logs

OPTIONS
  -d, --directory=directory       Directory to store logs into
  -h, --help                      show CLI help

  -n, --namespace=namespace       (required) The namespace where workspace is located. Can be found in workspace
                                  configuration 'attributes.infrastructureNamespace' field.

  -w, --workspace=workspace       (required) Target workspace id. Can be found in workspace configuration 'id' field.

  --follow                        Indicate if logs should be streamed

  --skip-kubernetes-health-check  Skip Kubernetes health check

  --telemetry=on|off              Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/workspace/logs.ts

`chectl workspace:start WORKSPACE`

Starts a workspace

USAGE
  $ chectl workspace:start WORKSPACE

ARGUMENTS
  WORKSPACE  The workspace id to start

OPTIONS
  -d, --debug
      Debug workspace start. It is useful when workspace start fails and it is needed to print more logs on startup.

  -h, --help
      show CLI help

  -n, --chenamespace=chenamespace
      Eclipse Che Kubernetes namespace. Default to 'eclipse-che'

  --access-token=access-token
      Eclipse Che OIDC Access Token. See the documentation how to obtain token: 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-keycloak_
      authenticating-to-the-che-server and 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-openshift
      -token-through-keycloak_authenticating-to-the-che-server.

  --che-api-endpoint=che-api-endpoint
      Eclipse Che server API endpoint

  --skip-kubernetes-health-check
      Skip Kubernetes health check

  --telemetry=on|off
      Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/workspace/start.ts

`chectl workspace:stop WORKSPACE`

Stop a running workspace

USAGE
  $ chectl workspace:stop WORKSPACE

ARGUMENTS
  WORKSPACE  The workspace id to stop

OPTIONS
  -h, --help
      show CLI help

  -n, --chenamespace=chenamespace
      Eclipse Che Kubernetes namespace. Default to 'eclipse-che'

  --access-token=access-token
      Eclipse Che OIDC Access Token. See the documentation how to obtain token: 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-keycloak_
      authenticating-to-the-che-server and 
      https://www.eclipse.org/che/docs/che-7/administration-guide/authenticating-users/#obtaining-the-token-from-openshift
      -token-through-keycloak_authenticating-to-the-che-server.

  --che-api-endpoint=che-api-endpoint
      Eclipse Che server API endpoint

  --skip-kubernetes-health-check
      Skip Kubernetes health check

  --telemetry=on|off
      Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry

See code: src/commands/workspace/stop.ts

Contributing

Contributing to chectl is covered in CONTRIBUTING.md

Name		Name	Last commit message	Last commit date
Latest commit History 687 Commits
.ci		.ci
.github		.github
.vscode		.vscode
bin		bin
configs		configs
installers		installers
src		src
test		test
.editorconfig		.editorconfig
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
RELEASE.md		RELEASE.md
ambient.d.ts		ambient.d.ts
custom-catalog-minikube.yaml		custom-catalog-minikube.yaml
devfile.yaml		devfile.yaml
make-release.sh		make-release.sh
package.json		package.json
run-script-in-docker.sh		run-script-in-docker.sh
tsconfig.json		tsconfig.json
tsfmt.json		tsfmt.json
yarn.lock		yarn.lock

License

rndsolutions/chectl

Folders and files

Latest commit

History

Repository files navigation

chectl

Report issues

Table Of Contents

Installation

Usage

Commands

chectl auth:delete CHE-API-ENDPOINT

chectl auth:get

chectl auth:list

chectl auth:login [CHE-API-ENDPOINT]

chectl auth:logout

chectl auth:use [CHE-API-ENDPOINT]

chectl autocomplete [SHELL]

chectl cacert:export

chectl dashboard:open

chectl devfile:generate

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 workspace:create

chectl workspace:delete WORKSPACE

chectl workspace:inject

chectl workspace:list

chectl workspace:logs

chectl workspace:start WORKSPACE

chectl workspace:stop WORKSPACE