cue-lang / cue

The home of the CUE language! Validate and define text-based and dynamic configuration
https://cuelang.org
Apache License 2.0
5.15k stars 296 forks source link
configuration data kubernetes validation

Go Reference Documentation Github Go 1.22+ [platforms]() Docker Image

CUE - Configure, Unify, Execute

CUE makes it easy to validate data, write schemas, and ensure configurations align with policies.

CUE works with a wide range of tools and formats that you're already using such as Go, JSON, YAML, OpenAPI, and JSON Schema.

For more information and documentation, including tutorials and guides, see cuelang.org.

Download and Install

The full range of installation methods for the cue command are listed on the cuelang.org site, 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 from GitHub.

Install from Source

You need Go 1.22 or later 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, 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.

More documentation including various tutorials can be found on the website.

References

Go release support policy

As a general rule, we support the two most recent major releases of Go, matching Go's 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.

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.

Contact


Unless otherwise noted, the CUE source files are distributed under the Apache 2.0 license found in the LICENSE file.