chectl

Eclipse Che CLI

• Installation
• Usage
• Commands

Installation

macOS

curl -sSLO https://github.com/l0rd/chectl/releases/download/latest/chectl-macos \
  && install chectl-macos /usr/local/bin/chectl

Linux

curl -sSLO https://github.com/l0rd/chectl/releases/download/latest/chectl-linux \
  && install chectl-linux /usr/local/bin/chectl

Usage

$ chectl server:start
running command...

$ chectl server:stop
running command...

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

Commands

• chectl help [COMMAND]
• chectl server:start
• chectl server:stop
• chectl server:update
• chectl workspace:list
• chectl workspace:start
• chectl workspace:stop

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:start

start Eclipse Che Server

USAGE
  $ chectl server:start

OPTIONS
  -d, --debug                          Starts chectl in debug mode
  -h, --help                           show CLI help
  -i, --cheimage=cheimage              [default: eclipse/che-server:nightly] Che server container image
  -n, --chenamespace=chenamespace      [default: kube-che] Kubernetes namespace where Che resources will be deployed
  -o, --cheboottimeout=cheboottimeout  (required) [default: 40000] Che server bootstrap timeout (in milliseconds)

  -t, --templates=templates            [default: /Users/mloriedo/github/chectl/src/templates] Path to the templates
                                       folder

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

chectl server:stop

stop Eclipse Che Server

USAGE
  $ chectl server:stop

OPTIONS
  -h, --help                       show CLI help
  -n, --chenamespace=chenamespace  [default: kube-che] Kubernetes namespace where Che resources will be deployed

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  [default: kube-che] Kubernetes namespace where Che resources will be deployed

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

chectl workspace:list

list Che workspaces

USAGE
  $ chectl workspace:list

OPTIONS
  -h, --help                       show CLI help
  -n, --chenamespace=chenamespace  [default: kube-che] Kubernetes namespace where Che server is deployed

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

chectl workspace:start

create and start a Che workspace

USAGE
  $ chectl workspace:start

OPTIONS
  -f, --devfile=devfile            (required) path to a valid devfile
  -h, --help                       show CLI help
  -n, --chenamespace=chenamespace  [default: kube-che] kubernetes namespace where Che server is deployed

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

chectl workspace:stop

stop a running Che workspace

USAGE
  $ chectl workspace:stop

OPTIONS
  -h, --help                       show CLI help
  -n, --chenamespace=chenamespace  [default: kube-che] Kubernetes namespace where Che server is deployed

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