@fsco/kcsetup
v0.0.1
Published
CLI tool for setting up and configuring Keycloak instances with organizations, roles, users, and themes
Readme
🚀 Features
- 🏢 Organization Management — Create and configure Keycloak organizations
- 👥 User Management — Bulk user creation with role assignments
- 🔑 Role Management — Define and assign custom roles
- 🎨 Theme Configuration — Customize Keycloak appearance
- 📧 SMTP Setup — Configure email providers
- 🔌 Provider Integration — Set up identity providers
- 📋 Multi-stage Support — Different configs for local, dev, staging, production
- ⚡ Fast Setup — Automated Keycloak configuration
- 🔧 Configurable — Flexible YAML/JSON configuration
📦 Installation
# Recommended
bunx @fsco/kcsetup init
# Or globally
bun add -g @fsco/kcsetupNPM/Yarn supported too:
npm install -g @fsco/kcsetup
npx @fsco/kcsetup init⚡ Quick Start
# 1. Initialize configuration
kcsetup init
# 2. Run complete setup
kcsetup run
# 3. Validate configuration
kcsetup validate
# 4. Check setup status
kcsetup status🔧 Configuration (fsco.yaml)
identity:
realm: "your-realm"
clientId: "admin-cli"
clientSecret: "your-secret"
urls:
local: "http://localhost:8080"
development: "https://dev.example.com"
staging: "https://staging.example.com"
production: "https://prod.example.com"
organizations:
- name: "Engineering"
description: "Engineering team"
attributes:
department: "IT"
roles:
- name: "admin"
description: "Administrator role"
users:
- username: "admin"
email: "[email protected]"
firstName: "Admin"
lastName: "User"
roles: ["admin"]Supported Keys
| Key | Description |
|-----------------|------------------------------------------------|
| organizations | Create and configure Keycloak organizations |
| roles | Define custom roles and permissions |
| users | Bulk user creation with role assignments |
| theme | Customize Keycloak appearance and branding |
| smtp | Configure email providers and templates |
| providers | Set up identity providers (OAuth, SAML, etc)|
📚 Commands
| Command | Description |
|-------------------------|------------------------------------------|
| kcsetup init | Create configuration file interactively |
| kcsetup run | Run complete Keycloak setup |
| kcsetup validate | Validate current configuration |
| kcsetup status | Check current setup status |
| kcsetup --help | Show detailed help menu |
