# Timoni

> Timoni is a package manager for Kubernetes powered by CUE lang.

## Docs

- [Quickstart Guide](https://timoni.sh/quickstart.md): Deploy a demo application on Kubernetes using a Timoni module published in a container registry.
- [Concepts](https://timoni.sh/concepts.md): Modules, instances, bundles and artifacts: the building blocks of Timoni.
- [Installation Guide](https://timoni.sh/install.md): Install the Timoni CLI on Linux, macOS and Windows.
- [Timoni compared to other tools](https://timoni.sh/comparison.md): How Timoni compares to Helm, Kustomize and other Kubernetes packaging tools.
- [Bundle](https://timoni.sh/bundle.md): Declare groups of module instances and their values in a single CUE file.
- [Bundle Runtime](https://timoni.sh/bundle-runtime.md): Fetch values at apply time from Kubernetes Secrets, ConfigMaps and other resources.
- [Bundle Distribution](https://timoni.sh/bundle-distribution.md): Publish bundles and runtimes as OCI artifacts to container registries.
- [Bundle Secrets Injection](https://timoni.sh/bundle-secrets.md): Inject secrets into bundles with runtime attributes or SOPS encrypted files.
- [Multi-cluster Deployments](https://timoni.sh/bundle-multi-cluster.md): Deliver applications across clusters and environments with bundles and runtimes.
- [Module Specification](https://timoni.sh/module.md): Structure, configuration schema and metadata of a Timoni module.
- [GitHub Actions](https://timoni.sh/github-actions.md): Build, test and push modules from GitHub workflows.
- [Flux AIO Distribution](https://timoni.sh/flux-aio.md): A lightweight Flux CD distribution packaged as a Timoni module.
- [Helm interoperability with Flux](https://timoni.sh/flux-helm-interop.md): Orchestrate Helm chart deployments from Timoni bundles through Flux.
- [GitOps Guide](https://timoni.sh/gitops-flux.md): Build a GitOps delivery pipeline for module instances with Timoni and Flux.
- [CUE Language](https://timoni.sh/cue/introduction.md): Why Timoni uses CUE and how to get started with the language.
- [CUE Features Walkthrough](https://timoni.sh/cue/walkthrough.md): Learn the core CUE features used to generate Kubernetes objects.
- [Get Started with Timoni Modules](https://timoni.sh/cue/module/initialization.md): Create a new module and learn its structure and development workflow.
- [Immutable ConfigMaps and Secrets](https://timoni.sh/cue/module/immutable-config.md): Generate immutable ConfigMaps and Secrets that roll out on change.
- [Embedding files](https://timoni.sh/cue/module/embedding-files.md): Embed configs, scripts and other plain files in modules with the @embed attribute.
- [Kubernetes Custom Resources](https://timoni.sh/cue/module/custom-resources.md): Define and validate Kubernetes custom resources in modules.
- [Kubernetes Version Constraints](https://timoni.sh/cue/module/semver-constraints.md): Adapt module output to the Kubernetes version of the target cluster.
- [Control the Apply Behavior](https://timoni.sh/cue/module/apply-behavior.md): Change how resources are applied with the action.timoni.sh annotations.
- [Custom Health Checks](https://timoni.sh/cue/module/health-checks.md): Declare readiness checks for custom resources that don't follow kstatus.
- [Run tests with Kubernetes Jobs](https://timoni.sh/cue/module/test-jobs.md): Write end-to-end tests as Kubernetes Jobs run by Timoni after deployment.
- [Import Kubernetes Resources from YAML](https://timoni.sh/cue/module/import-resources.md): Convert existing Kubernetes YAML manifests to CUE templates.
- [Module Publishing](https://timoni.sh/cue/module/publishing.md): Version and publish modules as OCI artifacts.
- [Module Signing and Verification](https://timoni.sh/cue/module/signing.md): Sign module artifacts with Cosign or Notation and verify them at apply time.
- [Module Distribution with GitHub Actions](https://timoni.sh/cue/module/github-actions.md): Publish module versions from GitHub workflows.
- [timoni](https://timoni.sh/cmd/timoni.md): A package manager for Kubernetes powered by CUE.
- [timoni version](https://timoni.sh/cmd/timoni_version.md): Print the client and API version information
- [timoni fmt](https://timoni.sh/cmd/timoni_fmt.md): Format CUE files
- [timoni apply](https://timoni.sh/cmd/timoni_apply.md): Install or upgrade a module instance
- [timoni build](https://timoni.sh/cmd/timoni_build.md): Build an instance from a module and print the resulting Kubernetes resources
- [timoni delete](https://timoni.sh/cmd/timoni_delete.md): Uninstall a module instance from the cluster
- [timoni list](https://timoni.sh/cmd/timoni_list.md): Prints a table of instances and their module version
- [timoni inspect](https://timoni.sh/cmd/timoni_inspect.md): Commands for getting information about installed instances
- [timoni inspect module](https://timoni.sh/cmd/timoni_inspect_module.md): Print the module information of an instance
- [timoni inspect values](https://timoni.sh/cmd/timoni_inspect_values.md): Print the values of an instance
- [timoni inspect resources](https://timoni.sh/cmd/timoni_inspect_resources.md): Print the Kubernetes objects managed by an instance
- [timoni status](https://timoni.sh/cmd/timoni_status.md): Displays the current status of Kubernetes resources managed by an instance
- [timoni mod](https://timoni.sh/cmd/timoni_mod.md): Commands for managing modules
- [timoni mod init](https://timoni.sh/cmd/timoni_mod_init.md): Create a module along with common files and directories
- [timoni mod build](https://timoni.sh/cmd/timoni_mod_build.md): Build a module OCI artifact on the local filesystem
- [timoni mod vet](https://timoni.sh/cmd/timoni_mod_vet.md): Validate a local module
- [timoni mod show](https://timoni.sh/cmd/timoni_mod_show.md): Commands for showing module information
- [timoni mod show config](https://timoni.sh/cmd/timoni_mod_show_config.md): Output the #Config structure of a local module
- [timoni mod push](https://timoni.sh/cmd/timoni_mod_push.md): Push a module to a container registry
- [timoni mod pull](https://timoni.sh/cmd/timoni_mod_pull.md): Pull a module version from a container registry
- [timoni mod list](https://timoni.sh/cmd/timoni_mod_list.md): List the versions of a module
- [timoni mod vendor](https://timoni.sh/cmd/timoni_mod_vendor.md): Commands for vendoring CUE schemas
- [timoni mod vendor k8s](https://timoni.sh/cmd/timoni_mod_vendor_k8s.md): Vendor Kubernetes API CUE schemas
- [timoni mod vendor crd](https://timoni.sh/cmd/timoni_mod_vendor_crd.md): Vendor Kubernetes CRD CUE schemas
- [timoni bundle](https://timoni.sh/cmd/timoni_bundle.md): Commands for managing bundles
- [timoni bundle apply](https://timoni.sh/cmd/timoni_bundle_apply.md): Install or upgrade instances from a bundle
- [timoni bundle build](https://timoni.sh/cmd/timoni_bundle_build.md): Build and print the resulting Kubernetes resources for all instances from a Bundle
- [timoni bundle delete](https://timoni.sh/cmd/timoni_bundle_delete.md): Delete all instances from a bundle
- [timoni bundle status](https://timoni.sh/cmd/timoni_bundle_status.md): Displays the current status of Kubernetes resources managed by the bundle instances
- [timoni bundle vet](https://timoni.sh/cmd/timoni_bundle_vet.md): Validate a bundle definition
- [timoni runtime](https://timoni.sh/cmd/timoni_runtime.md): Commands for managing runtimes
- [timoni runtime build](https://timoni.sh/cmd/timoni_runtime_build.md): Build validates the runtime definition, queries the cluster, extracts the values and prints them
- [timoni registry](https://timoni.sh/cmd/timoni_registry.md): Commands for managing the authentication to container registries
- [timoni registry login](https://timoni.sh/cmd/timoni_registry_login.md): Log in to a registry
- [timoni registry logout](https://timoni.sh/cmd/timoni_registry_logout.md): Log out of a registry
- [timoni artifact](https://timoni.sh/cmd/timoni_artifact.md): Commands for managing Open Container Initiative (OCI) artifacts
- [timoni artifact build](https://timoni.sh/cmd/timoni_artifact_build.md): Build an OCI artifact on the local filesystem
- [timoni artifact digest](https://timoni.sh/cmd/timoni_artifact_digest.md): Resolve the digest of an artifact
- [timoni artifact list](https://timoni.sh/cmd/timoni_artifact_list.md): List the tags of an artifact
- [timoni artifact push](https://timoni.sh/cmd/timoni_artifact_push.md): Push a directory contents to a container registry
- [timoni artifact pull](https://timoni.sh/cmd/timoni_artifact_pull.md): Pull an artifact from a container registry
- [timoni artifact tag](https://timoni.sh/cmd/timoni_artifact_tag.md): Tag an OCI artifact in the upstream registry
- [timoni completion](https://timoni.sh/cmd/timoni_completion.md): Generates completion scripts for various shells
- [timoni completion bash](https://timoni.sh/cmd/timoni_completion_bash.md): Generates bash completion scripts
- [timoni completion fish](https://timoni.sh/cmd/timoni_completion_fish.md): Generates fish completion scripts
- [timoni completion powershell](https://timoni.sh/cmd/timoni_completion_powershell.md): Generates powershell completion scripts
- [timoni completion zsh](https://timoni.sh/cmd/timoni_completion_zsh.md): Generates zsh completion scripts