Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 6 days ago
JSON representation
The home of the CUE language! Validate and define text-based and dynamic configuration
- Host: GitHub
- URL: https://github.com/cue-lang/cue
- Owner: cue-lang
- License: apache-2.0
- Created: 2021-07-02T14:55:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-31T15:47:11.000Z (14 days ago)
- Last Synced: 2025-02-01T07:00:29.414Z (13 days ago)
- Topics: configuration, data, kubernetes, validation
- Language: Go
- Homepage: https://cuelang.org
- Size: 43.2 MB
- Stars: 5,250
- Watchers: 46
- Forks: 302
- Open Issues: 946
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-repositories - cue-lang/cue - The home of the CUE language! Validate and define text-based and dynamic configuration (Go)
- awesome - cue-lang/cue - The home of the CUE language! Validate and define text-based and dynamic configuration (Go)
- awesome - cue-lang/cue - The home of the CUE language! Validate and define text-based and dynamic configuration (Go)
README
[](https://pkg.go.dev/cuelang.org/go)
[](https://cuelang.org/docs/)
[](https://github.com/cue-lang/cue/actions/workflows/trybot.yaml?query=branch%3Amaster+event%3Apush)
[](https://golang.org/dl/)
[]()
[](https://hub.docker.com/r/cuelang/cue)
# 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](https://cuelang.org).
### 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.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](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.