mvdan.cc
1<!--
2 Copyright 2018 The CUE Authors
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15-->
16[](https://pkg.go.dev/cuelang.org/go)
17[](https://cuelang.org/docs/)
18[](https://github.com/cue-lang/cue/actions/workflows/trybot.yaml?query=branch%3Amaster+event%3Apush)
19[](https://golang.org/dl/)
20[]()
21[](https://hub.docker.com/r/cuelang/cue)
22
23# CUE - _Configure, Unify, Execute_
24
25CUE makes it easy to validate data, write schemas,
26and ensure configurations align with policies.
27
28CUE works with a wide range of tools and formats that you're already using
29such as Go, JSON, YAML, TOML, OpenAPI, Protobuf, and JSON Schema.
30
31For more information and documentation, including __tutorials and guides__, see [cuelang.org](https://cuelang.org).
32
33### Download and Install
34
35The full range of installation methods for the `cue` command are listed on
36[cuelang.org](https://cuelang.org/docs/introduction/installation/),
37including the official container image suitable for use with Docker.
38Here are two common ways to install the command:
39
40#### Release builds
41
42Download the [latest release](https://github.com/cue-lang/cue/releases/latest/) from GitHub.
43
44#### Install from Source
45
46You need [Go 1.24 or later](https://go.dev/doc/install) to install CUE from source:
47
48 go install cuelang.org/go/cmd/cue@latest
49
50You can also clone the repository and build it directly via `go install ./cmd/cue`.
51
52### Learning CUE
53
54The fastest way to learn the basics is to follow [the language tour](https://cuelang.org/docs/tour/) on the website.
55
56The [cuelang.org](https://cuelang.org) website also contains
57[more documentation](https://cuelang.org/docs/), including
58[tutorials](https://cuelang.org/docs/tutorial/),
59[how-to guides](https://cuelang.org/docs/howto/),
60[concept guides](https://cuelang.org/docs/concept/), and
61[references](https://cuelang.org/docs/reference/).
62
63### Popular references
64
65- The official [CUE Language Specification](https://cuelang.org/docs/reference/spec/)
66- The CUE [Go API](https://pkg.go.dev/cuelang.org/go) on pkg.go.dev
67- [Builtin packages and functions](https://pkg.go.dev/cuelang.org/go/pkg)
68 available from CUE programs
69- [The `cue` command](https://cuelang.org/docs/reference/command/),
70 a versatile interface for working with data, CUE, and its ecosystem
71
72### Go release support policy
73
74As a general rule, we support the two most recent major releases of Go,
75matching Go's [security policy](https://go.dev/doc/security/policy).
76For example, if CUE v0.7.0 is released when Go's latest version is 1.21.5,
77v0.7.x including any following bugfix releases will require Go 1.20 or later.
78
79### Contributing
80
81To contribute, please read the [Contribution Guide](CONTRIBUTING.md).
82
83## Code of Conduct
84
85Guidelines for participating in CUE community spaces and a reporting process for
86handling issues can be found in the [Code of Conduct](https://cuelang.org/docs/reference/code-of-conduct/).
87
88## Contact
89
90- Ask questions via [GitHub Discussions](https://github.com/cue-lang/cue/discussions)
91- Chat with us on [Slack](https://cuelang.org/s/slack) and [Discord](https://cuelang.org/s/discord)
92- Subscribe to our [Community Calendar](https://cuelang.org/s/community-calendar) for community updates, demos, office hours, etc
93
94---
95
96Unless otherwise noted, the CUE source files are distributed
97under the Apache 2.0 license found in the LICENSE file.