Skip to content

Latest commit

 

History

History
111 lines (67 loc) · 3.32 KB

cli_reference.adoc

File metadata and controls

111 lines (67 loc) · 3.32 KB
Raw

CLI Reference

In this section you will learn about:

  • ✓ ways to configure ike (through flags, files et al.)

  • ✓ complete list of commands, and their available flags

Autocomplete

If you are using zsh or bash you can easily enable autocomplete for ike by invoking . <(ike completion SHELL).

Configuration

There are several ways to configure ike commands:

  1. Flags

  2. Environment variables

  3. Configuration file

Each item takes precedence over the item below it.

Environment variables are prefixed with IKE and have fully qualified names, for example in case of develop command and its port flag corresponding environment variable is IKE_DEVELOP_PORT.

Each of the commands can be persisted in the configuration file with all their flags respectively.

In case of develop command yaml file could look like:

develop:
  deployment: test
  run: "java -jar config.jar"
  port: 9876

See ike root command to learn about the global config flag and available formats.

Below you can find a documented list of all commands and their available flags.

Available commands

ike

Main command, which holds global flags and prints the overall usage of the tool.

cmd:ike

ike serve

Starts the controller in the cluster.

cmd:ike

ike create

Creates or joins existing development session in the cluster. Allows to re-route cluster network traffic to your local process.

The create command requires an image-reference to a repository which is reachable from within the cluster. It will prepare a session with the given image.

Important
 The create command will exit and leave the Session alive in the cluster as soon as it’s created.

cmd:ike

ike delete

Deletes or leaves existing development session in the cluster.

cmd:ike

ike develop

Creates or joins existing development session in the cluster. Allows to re-route cluster network traffic to your local process.

cmd:ike

Watching for changes

ike develop provides --watch functionality to trigger build and relaunch the process whenever you modify something in your project. This way you can immediately introduce your changes in your cluster.

By default, all log files (*.log) and .git folder are not monitored.

Tip
 For details on how define what should be watched see ike develop reference.

If you have .gitignore in the root directory, from where ike has been started, rules defined in this file are also respected.

Tip
 Have a look at official Git documentation to learn more about the .gitignore format.
Warning
 Only root .gitignore is handled. If you happen to have additional .gitignore files in subdirectories those won’t be respected.

ike version

Prints version of the binary and build metadata. cmd:ike

cmd:ike