Commands

• 1: jikkou action
• 2: jikkou api-extensions
• 3: jikkou api-resources
• 4: jikkou apply
• 5: jikkou config
• 6: jikkou config current-context
• 7: jikkou config get-contexts
• 8: jikkou config set-context
• 9: jikkou config use-context
• 10: jikkou config view
• 11: jikkou create
• 12: jikkou delete
• 13: jikkou diff
• 14: jikkou get
• 15: jikkou health
• 16: jikkou patch
• 17: jikkou prepare
• 18: jikkou replace
• 19: jikkou server-info
• 20: jikkou update
• 21: jikkou validate

1 - jikkou action

List and execute actions.

Synopsis

The action command manages Jikkou actions. Actions are named operations that can be executed on the target platform. Like the get command, action uses dynamic subcommands based on the actions available from your configured providers.

Each action is registered as a subcommand under jikkou action, and has an execute subcommand to run it.

jikkou action <action-name> execute [flags]

Examples

# List all available actions (shown as subcommands in help)
jikkou action --help

# Execute an action
jikkou action KafkaConsumerGroupsResetOffsets execute --options topic=my-topic --options group=my-group

# Execute an action with YAML output
jikkou action KafkaConsumerGroupsResetOffsets execute -o YAML

# Execute an action targeting a specific provider
jikkou action KafkaConsumerGroupsResetOffsets execute --provider kafka-prod --options topic=my-topic

Options (execute subcommand)

Additional options may be available depending on the action. These are dynamically registered based on the action’s ApiOptionSpec definitions. Use jikkou api-extensions get <action-name> to view options for a specific action.

Options inherited from parent commands

SEE ALSO

• jikkou api-extensions - List and inspect available extensions
• jikkou get - Display resources from the platform

2 - jikkou api-extensions

Print the supported API extensions.

Synopsis

The api-extensions command lists and inspects the API extensions registered in Jikkou. Extensions include resource collectors, transformations, validations, actions, health indicators, and controllers.

This command has two subcommands:

• api-extensions list - List all extensions
• api-extensions get - Get details about a specific extension

Subcommands

jikkou api-extensions list

Print a summary table of all supported API extensions.

jikkou api-extensions list [flags]

Examples

# List all extensions
jikkou api-extensions list

# List extensions of a specific category
jikkou api-extensions list --category Transformation

# List extensions from a specific provider
jikkou api-extensions list --provider kafka

# List extensions that support a specific resource kind
jikkou api-extensions list --kind KafkaTopic

Options

jikkou api-extensions get

Print detailed information about a specific API extension, including its title, description, configuration options, and usage examples.

jikkou api-extensions get <name> [flags]

Examples

# Get details about an extension in WIDE format (default)
jikkou api-extensions get KafkaTopicMaxRetentionMs

# Get details in JSON format
jikkou api-extensions get KafkaTopicMaxRetentionMs -o JSON

# Get details in YAML format
jikkou api-extensions get KafkaTopicMaxRetentionMs -o YAML

Options

Options inherited from parent commands

SEE ALSO

• jikkou api-resources - List available resource types
• jikkou get - Display resources of a given type

3 - jikkou api-resources

Print the supported API resources.

Synopsis

List the API resources supported by the Jikkou CLI or Jikkou API Server (in proxy mode). This command shows the resource name, short names, API version, kind, and supported verbs for each resource type.

Use this command to discover which resource types are available with your current configuration and providers.

jikkou api-resources [flags]

Examples

# List all available API resources
jikkou api-resources

# List resources for a specific API group
jikkou api-resources --api-group kafka.jikkou.io

# List resources that support specific verbs
jikkou api-resources --verbs LIST,GET

# List resources that support CREATE
jikkou api-resources --verbs CREATE

# Combine filters
jikkou api-resources --api-group kafka.jikkou.io --verbs LIST

Sample output

NAME               SHORTNAMES   APIVERSION               KIND                  VERBS
kafkatopics        kt           kafka.jikkou.io/v1beta2  KafkaTopic            CREATE, DELETE, GET, LIST, UPDATE
kafkaconsumergroups              kafka.jikkou.io/v1beta2  KafkaConsumerGroup    DELETE, GET, LIST

Options

Options inherited from parent commands

SEE ALSO

• jikkou api-extensions - List and inspect available extensions
• jikkou get - Display resources of a given type

4 - jikkou apply

Update the resources aand as described by the resource definition files.

Synopsis

Reconciles the target platform so that the resources match the resource definition files passed as arguments. This command uses the FULL reconciliation mode, meaning it will create, update, and delete resources as needed to match the desired state defined in your resource files.

jikkou apply [flags]

Examples

# Apply resources defined in a YAML file
jikkou apply -f my-resources.yaml

# Apply resources from a directory
jikkou apply -f ./resources/

# Apply resources with dry-run to preview changes
jikkou apply -f my-resources.yaml --dry-run

# Apply resources with specific selector
jikkou apply -f my-resources.yaml --selector 'metadata.name IN (my-topic)'

# Apply resources with template values
jikkou apply -f my-resources.yaml --values-files values.yaml

# Apply with inline template variable
jikkou apply -f my-resources.yaml -v topicName=my-topic

# Apply with custom labels
jikkou apply -f my-resources.yaml -l environment=production

# Apply with controller options
jikkou apply -f my-resources.yaml --options delete-orphans=true

# Apply targeting a specific provider
jikkou apply -f my-resources.yaml --provider kafka-prod

# Apply with JSON output format
jikkou apply -f my-resources.yaml -o JSON --pretty

Options

Options inherited from parent commands

SEE ALSO

• jikkou create - Create resources (CREATE mode only)
• jikkou update - Create or update resources (UPDATE mode only)
• jikkou delete - Delete resources (DELETE mode only)
• jikkou diff - Show changes without applying
• jikkou validate - Validate resource definitions

5 - jikkou config

Sets or retrieves the configuration of this client.

Synopsis

The config command manages Jikkou CLI configuration contexts. A context defines the configuration settings (config file path, inline properties, provider bindings) used when running Jikkou commands.

Configuration is stored in the Jikkou config file, located by default at $HOME/.jikkou/config.

Subcommands

Options inherited from parent commands

SEE ALSO

• Configuration - Learn how to configure Jikkou CLI

6 - jikkou config current-context

Display the current context.

Synopsis

Displays the current context used by Jikkou CLI, including the configuration file path and inline configuration properties associated with it.

jikkou config current-context

Examples

# Show the current context
$ jikkou config current-context
Using context 'localhost'

 KEY          VALUE
 ConfigFile
 ConfigProps  {"provider.kafka.config.client.bootstrap.servers":"localhost:9092"}

Options

This command has no specific options.

Options inherited from parent commands

SEE ALSO

• jikkou config get-contexts - List all contexts
• jikkou config use-context - Switch to a different context
• jikkou config view - Show the merged configuration
• jikkou config - Config command overview

7 - jikkou config get-contexts

List all configured contexts.

Synopsis

Get all contexts defined in the Jikkou config file. The current context is marked with an asterisk (*).

jikkou config get-contexts

Examples

# List all contexts
$ jikkou config get-contexts

 NAME
 localhost *
 development
 staging
 production

Options

This command has no specific options.

Options inherited from parent commands

SEE ALSO

• jikkou config current-context - Show the current context details
• jikkou config use-context - Switch to a context
• jikkou config set-context - Create or update a context
• jikkou config - Config command overview

8 - jikkou config set-context

Configure a context with the provided arguments.

Synopsis

Configures the specified context with the provided arguments. A context stores a reference to a configuration file and/or inline configuration properties. If the context already exists, it will be updated.

After setting a context, use jikkou config use-context to switch to it.

jikkou config set-context <context-name> [flags]

Examples

# Create a context with inline Kafka bootstrap server
jikkou config set-context localhost \
  --config-props=provider.kafka.config.client.bootstrap.servers=localhost:9092

# Create a context pointing to a configuration file
jikkou config set-context production --config-file=/path/to/production.conf

# Create a context with a properties file
jikkou config set-context staging --config-props-file=/path/to/staging.properties

# Create a context with provider-scoped properties
jikkou config set-context dev \
  --provider kafka \
  --config-props=client.bootstrap.servers=kafka-dev:9092

# Create a context with a config prefix
jikkou config set-context dev \
  --config-prefix=provider.kafka.config \
  --config-props=client.bootstrap.servers=kafka-dev:9092

Options

Arguments

Options inherited from parent commands

SEE ALSO

• jikkou config use-context - Switch to a context
• jikkou config get-contexts - List all contexts
• jikkou config - Config command overview

9 - jikkou config use-context

Switch to a specified context.

Synopsis

Configures Jikkou to use the specified context. All subsequent commands will use the configuration associated with this context.

jikkou config use-context <context-name>

Examples

# Switch to the production context
$ jikkou config use-context production
Using context 'production'

# If already using the specified context
$ jikkou config use-context production
Already using context production

Arguments

Options

This command has no specific options.

Options inherited from parent commands

SEE ALSO

• jikkou config get-contexts - List all available contexts
• jikkou config current-context - Display the current context
• jikkou config set-context - Create or update a context
• jikkou config - Config command overview

10 - jikkou config view

Show merged configuration settings.

Synopsis

Show the merged Jikkou configuration settings for the current context (or a named context). The configuration is rendered in HOCON format, showing all resolved values from the config file, inline properties, and defaults.

Use --debug to see the origin of each setting, or --comments to include human-written comments from the configuration files.

jikkou config view [flags]

Examples

# View the current configuration
jikkou config view

# View configuration for a specific context
jikkou config view --name production

# View configuration with origin comments (useful for debugging)
jikkou config view --debug

# View configuration with human-written comments
jikkou config view --comments

Options

Options inherited from parent commands

SEE ALSO

• jikkou config current-context - Display the current context
• jikkou config set-context - Create or update a context
• jikkou config - Config command overview

11 - jikkou create

Create resources from the resource definition files (only non-existing resources will be created).

Synopsis

Reconcile the target platform by creating all non-existing resources that are described by the resource definition files passed as arguments. This command uses the CREATE reconciliation mode, meaning only new resources will be created. Existing resources will not be updated or deleted.

jikkou create [flags]

Examples

# Create resources defined in a YAML file
jikkou create -f my-resources.yaml

# Preview what would be created
jikkou create -f my-resources.yaml --dry-run

# Create resources from a directory
jikkou create -f ./resources/

# Create resources with template values
jikkou create -f my-resources.yaml --values-files values.yaml

# Create resources targeting a specific provider
jikkou create -f my-resources.yaml --provider kafka-dev

Options

Options inherited from parent commands

SEE ALSO

• jikkou apply - Apply all changes (FULL mode)
• jikkou update - Create or update resources (UPDATE mode)
• jikkou delete - Delete resources (DELETE mode)
• jikkou diff - Show changes without applying

12 - jikkou delete

Delete resources that are no longer described by the resource definition files.

Synopsis

Reconcile the target platform by deleting all existing resources that are no longer described by the resource definition files passed as arguments. This command uses the DELETE reconciliation mode, meaning only deletions will be performed. No resources will be created or updated.

jikkou delete [flags]

Examples

# Delete resources no longer defined in a YAML file
jikkou delete -f my-resources.yaml

# Preview what would be deleted
jikkou delete -f my-resources.yaml --dry-run

# Delete resources from a directory
jikkou delete -f ./resources/

# Delete with selector to target specific resources
jikkou delete -f my-resources.yaml -s 'metadata.name IN (old-topic)'

# Delete resources targeting a specific provider
jikkou delete -f my-resources.yaml --provider kafka-dev

Options

Options inherited from parent commands

SEE ALSO

• jikkou apply - Apply all changes (FULL mode)
• jikkou create - Create resources only (CREATE mode)
• jikkou update - Create or update resources (UPDATE mode)
• jikkou diff - Show changes without applying

13 - jikkou diff

Show resource changes required by the current resource definitions.

Synopsis

Generates a speculative reconciliation plan, showing the resource changes Jikkou would apply to reconcile the resource definitions. This command does not actually perform the reconciliation actions.

Use diff to preview what changes would be made before running apply, create, update, or delete.

jikkou diff [flags]

Examples

# Show changes required by a resource definition file
jikkou diff -f my-resources.yaml

# Show only resources that would be created
jikkou diff -f my-resources.yaml --filter-resource-op CREATE

# Show only resources that would be created or deleted
jikkou diff -f my-resources.yaml --filter-resource-op CREATE,DELETE

# Filter changes to show only update operations
jikkou diff -f my-resources.yaml --filter-change-op UPDATE

# Output as a resource list
jikkou diff -f my-resources.yaml --list

# Output in JSON format
jikkou diff -f my-resources.yaml -o JSON

# Diff with a specific provider
jikkou diff -f my-resources.yaml --provider kafka-prod

# Diff with selector
jikkou diff -f my-resources.yaml -s 'metadata.name MATCHES (my-topic-.*)'

Options

Options inherited from parent commands

SEE ALSO

• jikkou apply - Apply all changes
• jikkou validate - Validate resource definitions
• jikkou prepare - Prepare resources for validation

14 - jikkou get

Display one or many specific resources.

Synopsis

Display one or many resources of a given type from the target platform. The get command uses dynamic subcommands based on the resource types available from your configured providers. Use jikkou api-resources to discover the available resource types.

When a resource name is specified, it retrieves that specific resource. Otherwise, it lists all resources of the given type.

jikkou get <resource-type> [name] [flags]

Examples

# List all Kafka topics
jikkou get kafkatopics

# Get a specific Kafka topic by name
jikkou get kafkatopics my-topic

# List resources with a selector
jikkou get kafkatopics -s 'metadata.name MATCHES (my-.*)'

# List resources with JSON output
jikkou get kafkatopics -o JSON

# List resources as a ResourceListObject
jikkou get kafkatopics --list

# List resources with custom options
jikkou get kafkatopics --options describe-default-configs=true

# List resources targeting a specific provider
jikkou get kafkatopics --provider kafka-prod

# Discover available resource types
jikkou api-resources --verbs LIST,GET

Options

Additional options may be available depending on the resource type. These are dynamically registered based on the provider’s ApiOptionSpec definitions. Use jikkou api-extensions get <extension-name> to view options for a specific resource collector.

Options inherited from parent commands

SEE ALSO

• jikkou api-resources - List available resource types
• jikkou api-extensions - List and inspect extensions
• jikkou diff - Show changes between desired and actual state

15 - jikkou health

Print or describe health indicators.

Synopsis

The health command provides information about the health of target environments. It has two subcommands:

• health get - Retrieve health status for one or all indicators
• health get-indicators - List all available health indicators

Subcommands

jikkou health get

Get health information for a specific indicator or all indicators.

jikkou health get <indicator|all> [flags]

Examples

# Get health for all indicators
jikkou health get all

# Get health for a specific indicator
jikkou health get kafka

# Get health with a custom timeout
jikkou health get all --timeout-ms 5000

# Get health in JSON format
jikkou health get all -o JSON

# Get health targeting a specific provider
jikkou health get kafka --provider kafka-prod

Options

The command exits with code 0 if the health status is UP, or a non-zero code otherwise.

jikkou health get-indicators

List all available health indicators. This command takes no options and displays the name and description of each registered health indicator.

jikkou health get-indicators

Examples

# List all health indicators
jikkou health get-indicators

Options

This subcommand has no specific options.

Options inherited from parent commands

SEE ALSO

• jikkou api-extensions - List and inspect extensions
• jikkou server-info - Display server information (proxy mode)

16 - jikkou patch

Execute all changes for the specified reconciliation mode.

Synopsis

Reconcile resources by applying all the changes as defined in the resource descriptor files passed through the arguments. Unlike the other reconciliation commands (apply, create, update, delete), patch requires you to explicitly specify the reconciliation mode using the --mode flag.

The patch command applies changes to existing resources on the platform by computing a diff between the current and desired states, then executing only the operations allowed by the selected mode.

jikkou patch --mode <mode> [flags]

Examples

# Patch resources using FULL reconciliation mode
jikkou patch --mode FULL -f my-resources.yaml

# Patch resources - create only
jikkou patch --mode CREATE -f my-resources.yaml

# Patch resources - update only
jikkou patch --mode UPDATE -f my-resources.yaml

# Preview patches without applying
jikkou patch --mode FULL -f my-resources.yaml --dry-run

# Patch with a specific provider
jikkou patch --mode UPDATE -f my-resources.yaml --provider kafka-prod

Options

Options inherited from parent commands

SEE ALSO

• jikkou apply - Apply all changes (FULL mode)
• jikkou replace - Replace resources by deleting and recreating
• jikkou diff - Show changes without applying

17 - jikkou prepare

Prepare the resource definition files for validation.

Synopsis

Prepare the resource definition files specified through the command line arguments for validation. This command applies all configured transformations to the resource definitions and outputs the result, without running validation rules or performing reconciliation.

Use prepare to inspect how your resources look after template rendering and transformations, before validation and reconciliation happen.

jikkou prepare [flags]

Examples

# Prepare resources from a YAML file
jikkou prepare -f my-resources.yaml

# Prepare resources from a directory
jikkou prepare -f ./resources/

# Prepare with template values
jikkou prepare -f my-resources.yaml --values-files values.yaml

# Prepare with JSON output
jikkou prepare -f my-resources.yaml -o JSON

# Prepare with selector
jikkou prepare -f my-resources.yaml -s 'metadata.name IN (my-topic)'

# Prepare targeting a specific provider
jikkou prepare -f my-resources.yaml --provider kafka-prod

Options

Options inherited from parent commands

SEE ALSO

• jikkou validate - Validate prepared resources
• jikkou apply - Apply changes
• jikkou diff - Show changes without applying

18 - jikkou replace

Replace all resources.

Synopsis

Replaces resources by deleting and (re)creating all the resources as defined in the resource descriptor files passed through the arguments. Unlike apply, which performs incremental updates, replace performs a full replacement of resources: existing resources are deleted first and then recreated from scratch.

Use replace when you need to ensure resources exactly match the desired state without any leftover configuration from previous versions.

jikkou replace [flags]

Examples

# Replace resources defined in a YAML file
jikkou replace -f my-resources.yaml

# Preview what would be replaced
jikkou replace -f my-resources.yaml --dry-run

# Replace resources from a directory
jikkou replace -f ./resources/

# Replace resources targeting a specific provider
jikkou replace -f my-resources.yaml --provider kafka-prod

# Replace with JSON output
jikkou replace -f my-resources.yaml -o JSON --pretty

Options

Options inherited from parent commands

SEE ALSO

• jikkou apply - Apply all changes (FULL mode)
• jikkou patch - Patch resources with a specified mode
• jikkou diff - Show changes without applying

19 - jikkou server-info

Display Jikkou API server information.

Synopsis

Print information about the Jikkou API server. This command is only available when Jikkou is configured in proxy mode (i.e., when jikkou.proxy.url is set in your configuration).

jikkou server-info [flags]

Examples

# Get server information in YAML format (default)
jikkou server-info

# Get server information in JSON format
jikkou server-info -o JSON

Options

Options inherited from parent commands

SEE ALSO

• jikkou health - Check health of target environments
• Configuration - Learn how to configure proxy mode

20 - jikkou update

Create or update resources from the resource definition files.

Synopsis

Reconcile the target platform by creating or updating resources that are described by the resource definition files passed as arguments. This command uses the UPDATE reconciliation mode, meaning new resources will be created and existing resources will be updated. Resources that exist on the platform but are not described in the resource files will not be deleted.

jikkou update [flags]

Examples

# Update resources defined in a YAML file
jikkou update -f my-resources.yaml

# Preview what would be created or updated
jikkou update -f my-resources.yaml --dry-run

# Update resources from a directory
jikkou update -f ./resources/

# Update resources with selector to filter specific resources
jikkou update -f my-resources.yaml -s 'metadata.name MATCHES (my-topic-.*)'

# Update resources targeting a specific provider
jikkou update -f my-resources.yaml --provider kafka-prod

Options

Options inherited from parent commands

SEE ALSO

• jikkou apply - Apply all changes (FULL mode)
• jikkou create - Create resources only (CREATE mode)
• jikkou delete - Delete resources (DELETE mode)
• jikkou diff - Show changes without applying

21 - jikkou validate

Check whether the resources definitions meet all validation requirements.

Synopsis

Validate the resource definition files specified through the command line arguments.

Validate runs all the user-defined validation requirements after performing any relevant resource transformations. Validation rules are applied only to resources matching the selectors passed through the command line arguments.

If validation passes, the command outputs the validated resources. If validation fails, the command prints the validation errors and exits with a non-zero status code.

jikkou validate [flags]

Examples

# Validate resources defined in a YAML file
jikkou validate -f my-resources.yaml

# Validate resources from a directory
jikkou validate -f ./resources/

# Validate with a selector to filter specific resources
jikkou validate -f my-resources.yaml -s 'metadata.name MATCHES (my-topic-.*)'

# Validate with template values
jikkou validate -f my-resources.yaml --values-files values.yaml

# Validate with JSON output
jikkou validate -f my-resources.yaml -o JSON

# Validate targeting a specific provider
jikkou validate -f my-resources.yaml --provider kafka-prod

Options

Options inherited from parent commands

SEE ALSO

• jikkou prepare - Prepare resources for validation
• jikkou apply - Apply changes after validation
• jikkou diff - Show changes without applying