Awesome
<!-- Copyright 2018 The CUE Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->
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.11.0
go install -ldflags='-X cuelang.org/go/cmd/cue/cmd.version=v0.11.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
- Language Specification: the official CUE Language specification
- Go API: the Go API on pkg.go.dev
- Builtin packages: builtin functions available from CUE programs
cueCLI: thecuecommand 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. 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
- Ask questions via GitHub Discussions
- Chat with us on Slack and Discord
- Subscribe to our 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.