kam 0.5.26

A lightweight, networkless CLI for scaffolding and packaging Magisk/Kernelsu/APU/Anykernel3/Astrbot/... modules.
Documentation
# Kam Project Environment Variables
# Copy this file to .env to use it.
# Variables defined here will be loaded during `kam build` and accessible in hooks.
#
# Note: Most KAM_* variables are automatically set by Kam during build.
# You only need to set variables here if you want to override defaults or provide
# additional configuration for hooks and build processes.

# ============================================================================
# Build Control Variables
# ============================================================================
# These variables control build behavior. Most are automatically set by command flags,
# but you can override them here if needed.

# Enable debug output in hooks (0 or 1)
# Set to 1 to enable verbose logging and debugging information
# KAM_DEBUG=1

# Enable version bump during build (0 or 1)
# Usually set automatically by `kam build --bump`
# KAM_BUMP_ENABLED=1

# Enable release creation during build (0 or 1)
# Usually set automatically by `kam build --release`
# KAM_RELEASE_ENABLED=1

# Enable signing during build (0 or 1)
# Usually set automatically by `kam build --sign`
# KAM_SIGN_ENABLED=1

# Enable pre-release mode (0 or 1)
# Usually set automatically by `kam build --pre-release`
# KAM_PRE_RELEASE=1

# Enable interactive mode (0 or 1)
# Usually set automatically by `kam build --interactive`
# KAM_INTERACTIVE=1

# Force non-interactive mode (0 or 1)
# Set to 1 to disable all interactive prompts (useful for CI/CD)
# KAM_NONINTERACTIVE=1

# ============================================================================
# Signing Configuration
# ============================================================================

# Private key for signing (PEM format)
# Alternative to using `kam secret` - you can provide the key directly
# Note: This is sensitive information - never commit this to version control!
# KAM_SIGN_KEY="-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"

# Passphrase for encrypted private key
# Required if your private key is encrypted with a passphrase
# Note: This is sensitive information - never commit this to version control!
# KAM_SIGN_PASSPHRASE="your_passphrase_here"

# Enable/disable Sigstore signing (0 or 1)
# Set to 0 to disable Sigstore attestation generation
# Default: 1 (enabled)
# KAM_SIGN_SIGSTORE=1

# ============================================================================
# Template Configuration
# ============================================================================

# Template cache directory
# Override the default template cache location (~/.kam/templates)
# KAM_TEMPLATE_CACHE_DIR="/path/to/template/cache"

# ============================================================================
# Author Information
# ============================================================================

# Author email address
# Used by `kam about` command to display contact information
# KAM_AUTHOR_EMAIL="author@example.com"

# ============================================================================
# CI/CD Environment Variables
# ============================================================================
# These are typically set automatically by CI/CD systems, but you can set them
# manually for local testing

# GitHub repository (format: owner/repo)
# Automatically detected from kam.toml or git remote
# GITHUB_REPOSITORY="owner/repo"

# GitHub branch or tag reference
# Automatically detected from git or CI environment
# GITHUB_REF="refs/heads/main"

# Generic CI environment flag
# Set by most CI systems automatically
# CI=true

# GitHub Actions environment flag
# Set automatically when running in GitHub Actions
# GITHUB_ACTIONS=true

# ============================================================================
# Automatically Set Variables (Read-only)
# ============================================================================
# The following variables are automatically set by Kam during build.
# You do NOT need to set these in .env - they are provided for reference only.
#
# KAM_PROJECT_ROOT          - Absolute path to project root
# KAM_HOOKS_ROOT            - Absolute path to hooks directory
# KAM_MODULE_ROOT           - Absolute path to module source directory
# KAM_WEB_ROOT              - Absolute path to webroot directory
# KAM_DIST_DIR              - Absolute path to build output directory
# KAM_MODULE_ID             - Module ID from kam.toml
# KAM_MODULE_VERSION        - Module version
# KAM_MODULE_VERSION_CODE   - Module version code
# KAM_MODULE_NAME           - Module name
# KAM_MODULE_AUTHOR         - Module author
# KAM_MODULE_DESCRIPTION    - Module description
# KAM_MODULE_UPDATE_JSON    - Update JSON URL
# KAM_STAGE                 - Current build stage (pre-build or post-build)
# KAM_GIT_REPO              - Git repository URL from kam.toml
# KAM_GITHUB_REPO           - GitHub repository (detected)
# KAM_REPO                  - Repository URL (same as KAM_GITHUB_REPO)
# KAM_REPO_REF              - Repository branch/tag reference
# KAM_RELEASE_TAG           - Release tag (usually version)
# KAM_PROP_*                - All prop.* fields from kam.toml (e.g., KAM_PROP_ID)
# KAM_TMPL_<NAME>           - Template variables (e.g., KAM_TMPL_FEATURE_X)
# KAM_<PATH>                - All flattened kam.toml keys (e.g., KAM_MMRL_REPO_REPOSITORY)
#
# For more information, see: https://github.com/MemDeco-WG/Kam

# KAM_HOME - Override Kam home directory (defaults to ~/.kam)
# KAM_HOME=~/.kam