Skip to content

CaddyGlow/zmk-glovebox

BranchesTags

Repository files navigation

Glovebox

A comprehensive tool for ZMK keyboard firmware management, supporting multiple keyboards with different build chains. Glovebox provides keymap building, firmware compilation, device flashing, and configuration management for ZMK-based keyboards.

Features

▶ Core Workflow

  • Multi-Keyboard Support: Extensible modular architecture with YAML-based configuration system
  • JSON→ZMK Pipeline: Convert JSON layouts to ZMK keymap and configuration files
  • Firmware Compilation: Multiple compilation strategies (zmk_config, moergo) with Docker integration
  • Cross-Platform Flashing: USB device detection and firmware flashing with retry logic
  • Profile System: Unified keyboard/firmware profiles with auto-detection capabilities

+ Advanced Layout Management

  • Variable Substitution System: Define reusable variables in layouts for consistency and maintainability
  • Version Management: Upgrade custom layouts while preserving customizations when new master versions are released
  • Unified Editing Interface: Batch operations for field manipulation, layer management, and variable control
  • Component Operations: Split/merge layouts into organized component files
  • Enhanced Comparison: DTSI-aware diff with patch generation and JSON output
  • ZMK Parser: Import existing ZMK keymap files back to JSON layouts

^ Performance & Caching

  • Intelligent Caching System: Multi-tier caching with shared coordination across domains
  • Workspace Management: Docker-based build workspaces with persistent caching
  • Dynamic Generation: Create complete ZMK config workspaces on-the-fly without external repositories
  • Build Matrix Support: GitHub Actions style matrices with automatic split keyboard detection

■ Development & Integration

  • Modular CLI Architecture: Focused command groups with unified interfaces
  • Library Management: Fetch, search, and organize layout libraries
  • MoErgo Integration: Authentication and API client for MoErgo services
  • Cloud Storage: Upload, download, and manage layouts in cloud storage
  • Debug Tracing: Comprehensive logging with stack traces and multiple verbosity levels

○ Configuration & Profiles

  • Type-Safe Configuration: YAML-based system with includes and inheritance
  • Profile Management: Full profiles (keyboard+firmware) and keyboard-only configurations
  • Auto-Detection: JSON auto-profiling and library resolution patterns
  • Batch Configuration: Multiple operations in unified configuration commands
  • Environment Support: Environment variables and flexible input/output handling

How It Works

Glovebox transforms keyboard layouts through a multi-stage pipeline:

Layout Editor → JSON File → ZMK Files → Firmware → Flash
  (Design)    →  (.json)  → (.keymap + .conf) → (.uf2) → (Keyboard)
  1. Design: Create layouts using the Glove80 Layout Editor
  2. Generate: Convert JSON to ZMK Device Tree Source (.keymap) and config (.conf) files
  3. Build: Compile ZMK files into firmware binary (.uf2)
  4. Flash: Transfer firmware to your keyboard via USB

The .keymap files use ZMK's Device Tree Source Interface (DTSI) format to define keyboard behavior at the firmware level.

Quick Start

Installation

Requirements

  • Python 3.11 or higher
  • Docker (required for firmware building)
  • Cross-Platform Device Flashing:
    • Linux: udisksctl (part of udisks2 package)
    • macOS: diskutil (built-in)
    • Windows: Not yet supported

Install from PyPI

pip install glovebox

Install from Source

git clone https://github.com/CaddyGlow/zmk-glovebox.git
cd zmk-glovebox

# Using uv (recommended)
uv pip install -e .

# Or using pip
pip install -e .

Install with Nix

If you use Nix, you can run Glovebox directly without installation:

# Run directly from the repository
nix run github:CaddyGlow/zmk-glovebox -- --help

# Run from a local clone
cd zmk-glovebox
nix run . -- --help

Or install it to your profile:

# Install from GitHub
nix profile install github:CaddyGlow/zmk-glovebox#venv

# Install from local clone
cd zmk-glovebox
nix profile install .#venv

Basic Usage

Build Layouts & Firmware

# Complete workflow: JSON → Keymap → Firmware
glovebox layout compile my_layout.json output/keymap --profile glove80/v25.05
glovebox firmware compile output/keymap.keymap output/keymap.conf --profile glove80/v25.05

# Direct compilation from JSON layout (auto-generates keymap/config)
glovebox firmware compile my_layout.json --profile glove80/v25.05

# Read from stdin with auto-profile detection
cat my_layout.json | glovebox layout compile - output/keymap

# Force overwrite existing files
glovebox layout compile my_layout.json output/keymap --profile glove80/v25.05 --force

Flash Firmware

# Flash with auto-detected keyboard profile
glovebox firmware flash glove80.uf2

# Flash with specific profile
glovebox firmware flash firmware.uf2 --profile glove80

# List available USB devices
glovebox firmware devices --profile glove80

# Flash multiple devices (e.g., split keyboard)
glovebox firmware flash firmware.uf2 --profile glove80 --count 2

Configuration Management

# Show current configuration
glovebox config show --defaults --descriptions

# Edit configuration with multiple operations
glovebox config edit \
  --get cache_strategy \
  --set icon_mode=text \
  --add keyboard_paths=/custom/path \
  --save

# List available keyboards and profiles
glovebox profile list
glovebox profile firmwares glove80

System Status & Diagnostics

# Check system status and diagnostics
glovebox status --profile glove80

# Show cache information
glovebox cache show

# Check for updates
glovebox config check-updates

Advanced Layout Operations

# Display layout in terminal
glovebox layout show my-layout.json

# Validate layout syntax and structure  
glovebox layout validate my-layout.json

# Split layout into organized component files
glovebox layout split my-layout.json components/

# Merge component files back into single layout
glovebox layout merge components/ --output merged-layout.json

# Parse ZMK keymap files to JSON layout
glovebox layout parse keymap my-keymap.keymap --output layout.json

Unified Layout Editing

# Comprehensive editing with multiple operations in one command
glovebox layout edit my-layout.json \
  --get "layers[0].name" \
  --set "title=Updated Layout Title" \
  --set "description=My custom layout" \
  --add-layer "SymbolLayer" --layer-position 3 \
  --remove-layer "UnusedLayer" \
  --save

# Field manipulation using dot notation
glovebox layout edit my-layout.json \
  --get "layers[0]" \
  --set "config_parameters[0].paramName=NEW_PARAM" \
  --save

# Layer operations with import/export
glovebox layout edit my-layout.json \
  --add-layer "CustomLayer" --layer-import-from layer.json \
  --export-layer "SymbolLayer" --layer-export-format bindings \
  --save

Version Management & Comparison

# Compare layouts with enhanced DTSI comparison
glovebox layout diff layout-v41.json layout-v42.json --include-dtsi --json

# Create and apply patches for automated transformations
glovebox layout diff old-layout.json new-layout.json --create-patch changes.patch
glovebox layout patch my-layout.json changes.patch --output upgraded-layout.json

Library & Cloud Management

# Manage layout libraries
glovebox library search "gaming layout"
glovebox library fetch @community/uuid-12345 --output gaming-layout.json
glovebox library list --format json

# Cloud storage operations
glovebox cloud upload my-layout.json --name "My Custom Layout"
glovebox cloud download layout-id --output downloaded-layout.json
glovebox cloud list --format table

# MoErgo service integration
glovebox moergo login --username user@email.com
glovebox moergo status

Cache & Workspace Management

# Cache operations
glovebox cache show --detailed
glovebox cache workspace show
glovebox cache workspace cleanup

# Clear cache for fresh builds
glovebox cache clear
glovebox cache workspace delete glove80

Metrics & Debugging

# Performance metrics
glovebox metrics list
glovebox metrics show session-id

# Debug logging with multiple verbosity levels
glovebox --debug layout compile my-layout.json output/
glovebox -vv firmware compile keymap.keymap config.conf --log-file debug.log

Perfect for:

  • Keeping custom layouts updated with new master releases
  • Preserving your personal customizations (layers, behaviors, config)
  • Batch editing operations with unified command interfaces
  • Automated layout manipulation and version control workflows
  • Component-based layout organization and management
  • Library integration for community layouts and sharing
  • Performance optimization with intelligent caching systems

Variable Management System

# Unified variable operations with the layout edit command

# List and inspect variables
glovebox layout edit my-layout.json \
  --list-variables \
  --list-variable-usage \
  --get-variable timing \
  --get-variable flavor

# Set and modify variables
glovebox layout edit my-layout.json \
  --set-variable timing=150 \
  --set-variable flavor=balanced \
  --remove-variable old_timing \
  --save

# Validate and flatten operations
glovebox layout edit my-layout.json \
  --validate-variables \
  --flatten-variables \
  --output final-layout.json

# Batch operations with dry run preview
glovebox layout edit my-layout.json \
  --set-variable timing=150 \
  --remove-variable old_timing \
  --dry-run

Example Layout with Variables:

{
  "keyboard": "glove80",
  "title": "My Layout",
  "variables": {
    "fast_timing": 130,
    "normal_timing": 190,
    "common_flavor": "tap-preferred",
    "positions": [0, 1, 2, 3]
  },
  "holdTaps": [
    {
      "name": "&fast_ht",
      "tappingTermMs": "${fast_timing}",
      "flavor": "${common_flavor}",
      "bindings": ["&kp", "&mo"]
    }
  ],
  "combos": [
    {
      "name": "esc_combo",
      "timeoutMs": "${fast_timing}",
      "keyPositions": "${positions}",
      "binding": {"value": "&kp", "params": [{"value": "ESC"}]}
    }
  ]
}

Variable Features:

  • Basic Substitution: ${variable_name} → resolved value
  • Default Values: ${optional_var:default_value} → fallback if variable undefined
  • Nested Properties: ${timing.fast} → access object properties
  • Type Preservation: Automatic coercion (strings → numbers/booleans)
  • Recursive Resolution: Variables can reference other variables
  • Circular Reference Detection: Prevents infinite loops
  • Usage Tracking: See exactly where each variable is used
  • Layout Flattening: Export final layouts with variables resolved

Perfect for:

  • Consistent Timing Values: Define timing once, use across all behaviors
  • Theming: Common colors, flavors, and settings
  • Bulk Updates: Change one variable to update multiple behaviors
  • Template Layouts: Create reusable layout templates
  • A/B Testing: Easy switching between different configurations
  • Sharing: Flatten variables for final distribution

Supported Keyboards

  • Glove80: Full support with MoErgo Nix toolchain and modular configuration
  • Corne: Standard ZMK build chain with split keyboard support and dynamic generation
  • Extensible: Modular YAML-based architecture designed for easy addition of new keyboards

Configuration System

Keyboards are now configured using a modular YAML system:

# keyboards/my_keyboard.yaml
includes:
  - "my_keyboard/main.yaml"

# keyboards/my_keyboard/main.yaml
keyboard: "my_keyboard"
description: "My Custom Keyboard"
includes:
  - "hardware.yaml"     # Hardware specifications
  - "firmwares.yaml"    # Firmware variants
  - "strategies.yaml"   # Compilation strategies
  - "behaviors.yaml"    # Behavior definitions

Advanced Features

Keyboard-Only Profiles

Use minimal keyboard configurations for operations that don't require keymap generation:

# Check keyboard status using keyboard-only profile  
glovebox status --profile glove80

# Flash pre-built firmware using keyboard-only profile
glovebox firmware flash firmware.uf2 --profile glove80

# List available configurations
glovebox config list --profile glove80

Use Cases:

  • Flashing Operations: Flash firmware without needing full keymap configuration
  • Status Checks: Query keyboard information and USB device detection
  • Minimal Setups: Simple configurations with only essential keyboard details

Advanced Compilation System

Glovebox provides multiple compilation strategies with intelligent caching:

Direct Strategy Selection

# Use specific compilation strategy via CLI
glovebox firmware compile keymap.keymap config.conf --profile glove80/v25.05 --strategy zmk_config
glovebox firmware compile keymap.keymap config.conf --profile corne/main --strategy west

Available Strategies:

  • zmk_config: GitHub Actions style builds with dynamic workspace generation
  • west: Traditional west workspace builds
  • cmake: Direct CMake builds
  • make: Makefile-based builds
  • ninja: Ninja build system
  • custom: User-defined build commands

Dynamic ZMK Config Generation

# Enable dynamic generation by using zmk_config strategy
# This automatically creates a complete ZMK workspace from your glovebox layout files

# The system automatically:
# - Creates build.yaml with appropriate targets (split keyboard detection)
# - Generates west.yml for ZMK dependency management  
# - Copies and renames keymap/config files to match shield conventions
# - Creates README.md and .gitignore for workspace documentation

# Build firmware using dynamic generation
glovebox firmware compile my_layout.keymap my_config.conf --profile corne/main --strategy zmk_config

# The workspace is created at ~/.glovebox/cache/workspaces/corne/ by default

Benefits:

  • No external repositories required: Everything generated from glovebox layout files
  • Automatic split keyboard detection: Generates left/right targets for Corne, Lily58, Sofle, Kyria
  • Shield naming conventions: Automatically renames files to match ZMK expectations
  • Full ZMK compatibility: Generated workspaces work with all standard ZMK workflows
  • Intelligent Caching: Multi-tier caching system dramatically reduces compilation times by reusing shared ZMK dependencies
  • Build Matrix Support: GitHub Actions style build matrices with parallel compilation

Docker Volume Permission Handling

Glovebox automatically handles Docker volume permission issues that can occur when building firmware on Linux/macOS systems:

# Volume permissions are automatically managed
glovebox firmware compile keymap.keymap config.conf --profile glove80/v25.05

# The system automatically:
# - Detects current user ID (UID) and group ID (GID)  
# - Adds --user UID:GID flag to Docker commands
# - Ensures build artifacts have correct host permissions
# - Works transparently across Linux and macOS platforms

Manual Override Options:

# Override UID/GID manually
glovebox firmware compile keymap.keymap config.conf --docker-uid 1001 --docker-gid 1001

# Specify custom username
glovebox firmware compile keymap.keymap config.conf --docker-username myuser

# Complete manual override
glovebox firmware compile keymap.keymap config.conf \
  --docker-uid 1001 --docker-gid 1001 --docker-username myuser \
  --docker-home /custom/home --docker-container-home /home/myuser

# Disable user mapping entirely
glovebox firmware compile keymap.keymap config.conf --no-docker-user-mapping

CLI Reference

Layout Commands

glovebox layout compile

Generate ZMK keymap and config files from a JSON keymap file.

glovebox layout compile [OPTIONS] JSON_FILE OUTPUT_FILE_PREFIX

Arguments:

  • JSON_FILE: Path to keymap JSON file (use '-' for stdin)
  • OUTPUT_FILE_PREFIX: Output directory and base filename (e.g., 'config/my_glove80')

Options:

  • --profile, -p: Profile to use (e.g., 'glove80/v25.05')
  • --force: Overwrite existing files

glovebox layout import-master (NEW)

Import a master layout version for future upgrades.

glovebox layout import-master [OPTIONS] JSON_FILE VERSION_NAME

Arguments:

  • JSON_FILE: Path to master layout JSON file
  • VERSION_NAME: Version identifier (e.g., 'v42', 'v42-pre')

Options:

  • --force: Overwrite existing version

glovebox layout upgrade (NEW)

Upgrade custom layout to new master version preserving customizations.

glovebox layout upgrade [OPTIONS] CUSTOM_LAYOUT --to-master VERSION

Arguments:

  • CUSTOM_LAYOUT: Path to custom layout to upgrade

Options:

  • --to-master: Target master version (required)
  • --from-master: Source master version (auto-detected if not specified)
  • --output: Output path (default: auto-generated)

glovebox layout list-masters (NEW)

List available master versions for a keyboard.

glovebox layout list-masters KEYBOARD

glovebox layout diff (ENHANCED)

Compare two layouts showing differences with enhanced DTSI support.

glovebox layout diff [OPTIONS] LAYOUT1 LAYOUT2

Options:

  • --include-dtsi: Include custom behaviors and device tree comparison
  • --json: Output structured JSON diff data
  • --output-format: Format for output (summary or detailed)

Field Manipulation Commands (NEW)

glovebox layout get-field

Retrieve field value from layout using dot notation.

glovebox layout get-field LAYOUT_FILE FIELD_PATH

Examples:

  • glovebox layout get-field layout.json "title"
  • glovebox layout get-field layout.json "layers[0]"
  • glovebox layout get-field layout.json "config_parameters[0].paramName"
glovebox layout set-field

Set field value in layout using dot notation.

glovebox layout set-field [OPTIONS] LAYOUT_FILE FIELD_PATH VALUE

Options:

  • --output: Output path (default: overwrites input)

Layer Management Commands (NEW)

glovebox layout add-layer

Add a new layer to a layout.

glovebox layout add-layer [OPTIONS] LAYOUT_FILE LAYER_NAME

Options:

  • --position: Position to insert layer (default: append)
  • --import-from: Import layer data from JSON file
  • --import-layer: Specify layer name when importing from full layout
  • --output: Output path (default: overwrites input)
glovebox layout remove-layer

Remove a layer from a layout.

glovebox layout remove-layer [OPTIONS] LAYOUT_FILE LAYER_NAME
glovebox layout move-layer

Move a layer to a different position.

glovebox layout move-layer [OPTIONS] LAYOUT_FILE LAYER_NAME --position POSITION

Note: Use --position -1 for last position. Use -- separator: move-layer layout.json "Layer" -- -1

glovebox layout export-layer

Export a layer to JSON file.

glovebox layout export-layer [OPTIONS] LAYOUT_FILE LAYER_NAME

Options:

  • --format: Export format (bindings, layer, full)
  • --output: Output file path

Variable Management Commands (NEW)

glovebox layout variables

Unified variable management command with batch operations support.

glovebox layout variables [OPTIONS] LAYOUT_FILE

Variable Display Options:

  • --list: List all variables in the layout
  • --list-resolved: List variables with their resolved values
  • --list-usage: Show where each variable is used in the layout
  • --get VAR_NAME: Get specific variable value(s) (can be used multiple times)

Variable Modification Options:

  • --set VAR=VALUE: Set variable value (can be used multiple times)
  • --remove VAR_NAME: Remove variable(s) by name (can be used multiple times)

Variable Operations:

  • --validate: Validate all variable references can be resolved
  • --flatten: Resolve all variables and remove variables section

General Options:

  • --output, -o: Output file (required for --flatten, optional for modifications)
  • --output-format: Output format (text, json, markdown, table)
  • --force: Overwrite existing files
  • --save/--no-save: Save changes to file (default: save)
  • --dry-run: Show what would be done without making changes

Examples:

# List all variables
glovebox layout variables layout.json --list

# Show variables with resolved values
glovebox layout variables layout.json --list-resolved

# Get specific variable values
glovebox layout variables layout.json --get timing --get flavor

# Set multiple variables
glovebox layout variables layout.json --set timing=150 --set flavor=balanced

# Batch operations with validation
glovebox layout variables layout.json --set timing=150 --remove old_timing --validate

# Flatten layout (resolve variables, remove variables section)
glovebox layout variables layout.json --flatten --output final-layout.json

# Dry run to preview changes
glovebox layout variables layout.json --set timing=150 --dry-run

Variable Syntax in JSON:

  • Basic: "${variable_name}" → resolved to variable value
  • Default: "${variable_name:default_value}" → uses default if variable undefined
  • Nested: "${object.property}" → access nested object properties
  • Type Coercion: Strings automatically converted to numbers/booleans when appropriate

Patch Operations (NEW)

glovebox layout patch

Apply JSON diff patch to transform a layout.

glovebox layout patch [OPTIONS] LAYOUT_FILE PATCH_FILE
glovebox layout create-patch

Generate merge-tool compatible patch between two layouts.

glovebox layout create-patch [OPTIONS] OLD_LAYOUT NEW_LAYOUT

Options:

  • --output: Output patch file path
  • --include-dtsi: Include DTSI code differences

glovebox layout decompose

Extract layers from a keymap file into individual layer files.

glovebox layout decompose [OPTIONS] KEYMAP_FILE OUTPUT_DIR

Creates structure:

output_dir/
├── metadata.json       # Keymap metadata configuration
├── behaviors.json      # Behavior definitions (holdTaps, combos, macros, variables)
├── device.dtsi         # Custom device tree (if present)
├── keymap.dtsi         # Custom behaviors (if present)
└── layers/
    ├── DEFAULT.json
    ├── LOWER.json
    └── ...

glovebox layout compose

Merge layer files into a single keymap file.

glovebox layout compose [OPTIONS] INPUT_DIR

Options:

  • --output, -o: Output keymap JSON file path
  • --force: Overwrite existing files

glovebox layout show

Display keymap layout in terminal.

glovebox layout show [OPTIONS] JSON_FILE

Options:

  • --key-width, -w: Width for displaying each key (default: 10)

Firmware Commands

glovebox firmware compile

Compile firmware from keymap and config files.

glovebox firmware compile [OPTIONS] KEYMAP_FILE KCONFIG_FILE

Options:

  • --profile, -p: Profile to use (e.g., 'glove80/v25.05')
  • --output-dir, -o: Build output directory (default: build)
  • --branch: Git branch to use (overrides profile settings)
  • --repo: Git repository (overrides profile settings)
  • --jobs, -j: Number of parallel jobs
  • --verbose, -v: Enable verbose build output

Docker User Context Override Options:

  • --docker-uid: Manual Docker UID override
  • --docker-gid: Manual Docker GID override
  • --docker-username: Manual Docker username override
  • --docker-home: Custom Docker home directory override
  • --docker-container-home: Custom container home directory path
  • --no-docker-user-mapping: Disable Docker user mapping entirely

glovebox firmware flash

Flash firmware to USB devices.

glovebox firmware flash [OPTIONS] FIRMWARE_FILE

Options:

  • --profile, -p: Profile to use (e.g., 'glove80/v25.05')
  • --query, -q: Device query string (default: from profile)
  • --timeout: Device detection timeout in seconds (default: 60)
  • --count, -n: Number of devices to flash (default: 2, 0 for unlimited)
  • --no-track: Allow flashing same device multiple times

Device Query Format:

# Match by vendor
--query "vendor=Adafruit"

# Match by serial pattern
--query "serial~=GLV80-.*"

# Combine conditions
--query "vendor=Adafruit and serial~=GLV80-.* and removable=true"

# Available operators: = (exact), != (not equal), ~= (regex)

Configuration Commands

glovebox config list

Show current configuration settings with optional defaults and descriptions.

glovebox config list [OPTIONS]

Options:

  • --sources: Show configuration sources
  • --defaults: Show default values alongside current values
  • --descriptions: Show field descriptions

glovebox config edit

Unified configuration editing command supporting multiple operations.

glovebox config edit [OPTIONS]

Options:

  • --get KEY: Get configuration values (can be used multiple times)
  • --set KEY=VALUE: Set configuration values (can be used multiple times)
  • --add KEY=VALUE: Add values to list configurations (can be used multiple times)
  • --remove KEY=VALUE: Remove values from list configurations (can be used multiple times)
  • --save/--no-save: Save configuration to file (default: save)

Examples:

# Get configuration values
glovebox config edit --get keyboard_paths --get cache_strategy

# Set configuration values
glovebox config edit --set cache_strategy=shared --set emoji_mode=true

# Add to configuration lists
glovebox config edit --add keyboard_paths=/new/path

# Remove from configuration lists
glovebox config edit --remove keyboard_paths=/old/path

# Combined operations
glovebox config edit --set cache_strategy=shared --add keyboard_paths=/new/path --save

glovebox config export

Export configuration to file with current values.

glovebox config export [OPTIONS]

Options:

  • --output, -o: Output file path (default: glovebox-config.yaml)
  • --format, -f: Output format (yaml, json, toml)
  • --include-defaults/--no-defaults: Include default values
  • --include-descriptions/--no-descriptions: Include field descriptions as comments

glovebox config import

Import configuration from a YAML, JSON, or TOML file.

glovebox config import [OPTIONS] CONFIG_FILE

Options:

  • --dry-run: Show what would be imported without making changes
  • --backup/--no-backup: Create backup of current config before importing
  • --force: Import without confirmation prompts

Keyboard Commands

glovebox keyboard list

List available keyboard configurations.

glovebox keyboard list [OPTIONS]

Options:

  • --verbose, -v: Show detailed information
  • --format, -f: Output format (text, json)

glovebox keyboard show

Show details of a specific keyboard configuration.

glovebox keyboard show [OPTIONS] KEYBOARD_NAME

Options:

  • --format, -f: Output format (text, json, markdown, table)
  • --verbose, -v: Show detailed configuration information

glovebox keyboard firmwares

List available firmware configurations for a keyboard.

glovebox keyboard firmwares [OPTIONS] KEYBOARD_NAME

Options:

  • --format, -f: Output format (text, json)

glovebox status

Show system status and diagnostics.

glovebox status [OPTIONS]

Options:

  • --profile, -p: Profile to use for keyboard-specific checks

Shell Completion

# Install completion for current shell
glovebox --install-completion

# Show completion for current shell
glovebox --show-completion

Configuration

Configuration System

Glovebox uses a comprehensive type-safe configuration system:

  1. Keyboard Configurations: YAML files that define keyboard-specific configurations
  2. Firmware Configurations: Multiple firmware variants per keyboard
  3. User Configuration: User-specific settings with multi-source precedence
  4. KeyboardProfile: Unified access to keyboard and firmware configuration

Example Keyboard Configuration

Modular Configuration Structure

# keyboards/glove80.yaml (main entry point)
includes:
  - "glove80/main.yaml"

# keyboards/glove80/main.yaml
keyboard: "glove80"
description: "MoErgo Glove80 split ergonomic keyboard"
vendor: "MoErgo"
key_count: 80

includes:
  - "hardware.yaml"     # Hardware specifications
  - "firmwares.yaml"    # Firmware variants
  - "strategies.yaml"   # Compilation strategies
  - "kconfig.yaml"      # Kconfig options
  - "behaviors.yaml"    # Behavior definitions

# keyboards/glove80/strategies.yaml
compile_methods:
  - type: "moergo"
    image: "glove80-zmk-config-docker"
    repository: "moergo-sc/zmk"
    branch: "v25.05"
    build_matrix:
      board: ["glove80_lh", "glove80_rh"]
    docker_user:
      enable_user_mapping: false

# keyboards/glove80/firmwares.yaml
firmwares:
  v25.05:
    description: "Stable MoErgo firmware v25.05"
    version: "v25.05"
    branch: "v25.05"

Adding New Keyboards

To add support for a new keyboard:

  1. Create modular configuration structure:

    keyboards/
├── my_keyboard.yaml        # Main entry point
└── my_keyboard/
    ├── main.yaml           # Core configuration
    ├── hardware.yaml       # Hardware specs
    ├── firmwares.yaml      # Firmware variants
    ├── strategies.yaml     # Compilation methods
    ├── kconfig.yaml        # Kconfig options
    └── behaviors.yaml      # Behavior definitions

  2. Define compilation strategies and flash configuration

  3. Add firmware variants for different builds

  4. Test configuration discovery with glovebox config list

  5. Test compilation with glovebox firmware compile --profile my_keyboard/firmware_version

Troubleshooting

Common Issues

Docker not available:

# Check Docker installation
docker --version

# Start Docker service (Linux)
sudo systemctl start docker

USB device not detected:

# Linux: Check device permissions and groups
ls -la /dev/disk/by-id/
sudo usermod -a -G plugdev,dialout $USER

# macOS: Check device is mountable
diskutil list

# Check if device matches query
glovebox firmware devices --profile glove80/v25.05

Debug Logging

Glovebox provides comprehensive debug tracing with automatic stack traces:

# Verbose flag hierarchy (with precedence: --debug > -vv > -v > config > default)
glovebox --debug [command]     # DEBUG level + stack traces (highest priority)
glovebox -vv [command]         # DEBUG level + stack traces  
glovebox -v [command]          # INFO level + stack traces
glovebox [command]             # User config or WARNING level (clean output)

# Examples with common commands
glovebox --debug status                                    # Debug keyboard detection
glovebox -vv layout compile layout.json output/           # Debug layout generation
glovebox -v firmware compile keymap.keymap config.conf    # Info level firmware build

# Log to file for persistent debugging
glovebox --debug --log-file debug.log firmware compile keymap.keymap config.conf

Key Features:

  • Automatic Stack Traces: All verbose flags (-v, -vv, --debug) show stack traces on errors
  • Clean Error Messages: No verbose flags = user-friendly error messages only
  • Flag Precedence: --debug > -vv > -v > user config > WARNING (default)
  • File Logging: Persist debug information with --log-file

Documentation

Comprehensive documentation is available in the docs/ directory:

Documentation Structure

▶ Quick Navigation

New Users: Start with Getting Started → CLI Reference

Developers: Begin with Developer Quick Start → Architecture Overview

Advanced Users: Reference Technical Documentation for deep integration details

Development

Development Installation

git clone https://github.com/your-org/glovebox.git
cd glovebox

# Using uv (recommended)
uv sync
pre-commit install

# Or using pip
pip install -e ".[dev]"
pre-commit install

For complete setup instructions, see the Development Setup Guide.

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=glovebox

# Run specific test category
pytest -m unit
pytest -m integration

See Testing Strategy for comprehensive testing guidelines.

Code Quality

# Using make (recommended)
make lint          # Run linting checks
make format        # Format code and fix issues
make test          # Run all tests
make coverage      # Run tests with coverage

# Manual commands
ruff check . --fix  # Lint and fix
ruff format .       # Format code
mypy glovebox/      # Type checking

# Pre-commit hooks (recommended)
pre-commit install
pre-commit run --all-files

All code must follow the standards outlined in Code Conventions.

Contributing

  1. Fork the repository
  2. Create feature branch: git checkout -b feature/new-keyboard
  3. Follow the Adding New Features guide
  4. Add comprehensive tests (see Testing Strategy)
  5. Run quality checks: ruff check . && ruff format . && pytest
  6. Submit pull request

See Developer Documentation for detailed contribution guidelines.

License

MIT License - see LICENSE file for details.

Support

For troubleshooting help, see the Troubleshooting Guide.

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases 2

Release v0.1.1 Latest
Aug 4, 2025
+ 1 release

Packages

 
 
 

Contributors

Languages