Skip to content
Star Fork

CI GitHub release Docker Pulls codecov GitHub license

Keycloak Config CLI

keycloak-config-cli is a declarative configuration tool for managing Keycloak. It allows you to define and maintain your Keycloak setup—such as realms, clients, users, and roles—using JSON or YAML files instead of manual UI operations.

By treating configuration as code, you can ensure consistency, repeatability, and easier maintenance across different environments without relying on manual changes in the Keycloak Admin Console.

Key Features

  • Declarative Configuration: Define the desired state of your Keycloak instance using JSON or YAML
  • Idempotent Execution: Apply configurations multiple times without creating duplicates or inconsistencies
  • Automation Ready: Integrate seamlessly into CI/CD pipelines and deployment workflows
  • Version Controlled: Store configurations in Git to track and manage changes over time

How It Works

keycloak-config-cli connects to a running Keycloak instance and applies the provided configuration files. It compares the current state with the desired state and performs only the necessary updates.

This ensures your Keycloak instance always remains aligned with your configuration.

Who Is It For?

keycloak-config-cli is useful for:

  • Developers managing local or development environments
  • DevOps engineers automating infrastructure and deployments
  • Teams maintaining consistent configurations across multiple environments

Documentation Overview

This documentation helps you:

  • Get started quickly with installation and setup
  • Understand configuration options and supported resources
  • Explore advanced usage and integration patterns
  • Troubleshoot common issues and edge cases

Next Steps