Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cue-lang/cue

The home of the CUE language! Validate and define text-based and dynamic configuration
https://github.com/cue-lang/cue

configuration data kubernetes validation

Last synced: 10 days ago
JSON representation

The home of the CUE language! Validate and define text-based and dynamic configuration

Awesome Lists containing this project

README 

        

[![Go Reference](https://pkg.go.dev/badge/cuelang.org/go.svg)](https://pkg.go.dev/cuelang.org/go)

[![Github](https://github.com/cue-lang/cue/actions/workflows/trybot.yaml/badge.svg)](https://github.com/cue-lang/cue/actions/workflows/trybot.yaml?query=branch%3Amaster+event%3Apush)

[![Go 1.22+](https://img.shields.io/badge/go-1.22-9cf.svg)](https://golang.org/dl/)

[![platforms](https://img.shields.io/badge/platforms-linux|windows|macos-inactive.svg)]()

[![Docker Image](https://img.shields.io/docker/v/cuelang/cue?sort=semver&label=docker)](https://hub.docker.com/r/cuelang/cue)



# The CUE Data Constraint Language



_Configure, Unify, Execute_



CUE is an open source data constraint language which aims

to simplify tasks involving defining and using data.



It is a superset of JSON,

allowing users familiar with JSON to get started quickly.



### What is it for?



You can use CUE to



- define a detailed validation schema for your data (manually or automatically from data)

- reduce boilerplate in your data (manually or automatically from schema)

- extract a schema from code

- generate type definitions and validation code

- merge JSON in a principled way

- define and run declarative scripts



### How?



CUE merges the notion of schema and data.

The same CUE definition can simultaneously be used for validating data

and act as a template to reduce boilerplate.

Schema definition is enriched with fine-grained value definitions

and default values.

At the same time,

data can be simplified by removing values implied by such detailed definitions.

The merging of these two concepts enables

many tasks to be handled in a principled way.



Constraints provide a simple and well-defined, yet powerful, alternative

to inheritance,

a common source of complexity with configuration languages.



### CUE Scripting



The CUE scripting layer defines declarative scripting, expressed in CUE,

on top of data.

This solves three problems:

working around the closedness of CUE definitions (we say CUE is hermetic),

providing an easy way to share common scripts and workflows for using data,

and giving CUE the knowledge of how data is used to optimize validation.



There are many tools that interpret data or use a specialized language for

a specific domain (Kustomize, Ksonnet).

This solves dealing with data on one level, but the problem it solves may repeat

itself at a higher level when integrating other systems in a workflow.

CUE scripting is generic and allows users to define any workflow.



### Tooling



CUE is designed for automation.

Some aspects of this are:



- convert existing YAML and JSON

- automatically simplify configurations

- rich APIs designed for automated tooling

- formatter

- arbitrary-precision arithmetic

- generate CUE templates from source code

- generate source code from CUE definitions (TODO)



### Download and Install



The full range of installation methods for the `cue` command are listed on the

[cuelang.org site](https://cuelang.org/docs/introduction/installation/),

including the official container image suitable for use with Docker.

Here are two common ways to install the command:



#### Release builds



Download the [latest release](https://github.com/cue-lang/cue/releases/latest/) from GitHub.



#### Install from Source



You need [Go 1.22 or later](https://go.dev/doc/install) to install CUE from source:



	go install cuelang.org/go/cmd/cue@latest



You can also clone the repository and build it directly via `go install ./cmd/cue`.

Note that local builds [lack version information](https://go.dev/issue/50603),

so you should inject the version string when building a release, such as:



	git switch -d v0.9.0

	go install -ldflags='-X cuelang.org/go/cmd/cue/cmd.version=v0.9.0' ./cmd/cue



### Learning CUE



The fastest way to learn the basics is to follow the [tour on the website](https://cuelang.org/docs/tour/).



More documentation including various tutorials can be found [on the website](https://cuelang.org/docs/).



### References



- [Language Specification](https://cuelang.org/docs/reference/spec/): the official CUE Language specification

- [Go API](https://pkg.go.dev/cuelang.org/go/cue): the Go API on pkg.go.dev

- [Builtin packages](https://pkg.go.dev/cuelang.org/go/pkg): builtin functions available from CUE programs

- [`cue` CLI](https://cuelang.org/docs/reference/cli/): the `cue` command line interface



### Go release support policy



As a general rule, we support the two most recent major releases of Go,

matching Go's [security policy](https://go.dev/doc/security/policy).

For example, if CUE v0.7.0 is released when Go's latest version is 1.21.5,

v0.7.x including any following bugfix releases will require Go 1.20 or later.



### Contributing



To contribute, please read the [Contribution Guide](CONTRIBUTING.md).



## Code of Conduct



Guidelines for participating in CUE community spaces and a reporting process for

handling issues can be found in the [Code of Conduct](https://cuelang.org/docs/reference/code-of-conduct/).



## Contact



- Ask questions via [GitHub Discussions](https://github.com/cue-lang/cue/discussions)

- Chat with us on [Slack](https://cuelang.org/s/slack) and [Discord](https://cuelang.org/s/discord)

- Subscribe to our [Community Calendar](https://cuelang.org/s/community-calendar) for community updates, demos, office hours, etc



---



Unless otherwise noted, the CUE source files are distributed

under the Apache 2.0 license found in the LICENSE file.