Overview

Mon, 01 Jan 0001 00:00:00 +0000

The command line interface to Jikkou is the jikkou command, which accepts a variety of subcommands such as jikkou apply or jikkou validate.

To view a list of the commands available in your current Jikkou version, run jikkou with no additional arguments:

Usage: 
jikkou [-hV] [--logger-level=<level>] [COMMAND]


Jikkou CLI:: A command-line client designed to provide an efficient and easy way to manage, automate, and provision resources.

Find more information at: https://www.jikkou.io/.

OPTIONS:

 -h, --help Show this help message and exit.
 --logger-level=<level>
 Specify the log level verbosity to be used while running a command.
 Valid level values are: TRACE, DEBUG, INFO, WARN, ERROR.
 For example, `--logger-level=INFO`
 -V, --version Print version information and exit.

CORE COMMANDS:
 apply Update the resources as described by the resource definition files.
 create Create resources from the resource definition files (only non-existing resources will be created).
 delete Delete resources that are no longer described by the resource definition files.
 diff Show resource changes required by the current resource definitions.
 get Display one or many specific resources.
 patch Execute all changes for the specified reconciliation mode.
 prepare Prepare the resource definition files for validation.
 replace Replace all resources.
 update Create or update resources from the resource definition files
 validate Check whether the resources definitions meet all validation requirements.

SYSTEM MANAGEMENT COMMANDS:
 action List/execute actions.
 health Print or describe health indicators.

ADDITIONAL COMMANDS:
 api-extensions Print the supported API extensions
 api-resources Print the supported API resources
 config Sets or retrieves the configuration of this client
 generate-completion Generate bash/zsh completion script for jikkou.
 help Display help information about the specified command.

See 'jikkou --help' for more information about a command.

(The output from your current Jikkou version may be different than the above example.)

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Configuration

To set up the configuration settings used by Jikkou CLI, you will need create a jikkou config file, which is created automatically when you create a configuration context using:

jikkou config set-context <context-name> [--config-file=<config-file>] [--config-props=<config-value>]

By default, the configuration of jikkou is located under the path $HOME/.jikkou/config.

This jikkou config file defines all the contexts that can be used by jikkou CLI.

For example, below is the config file created during the Getting Started.

Jikkou CLI on Jikkou

Overview

Configuration

Configuration