cuelang.org/go@v0.13.0/README.md (about)

     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  [![Go Reference](https://pkg.go.dev/badge/cuelang.org/go.svg)](https://pkg.go.dev/cuelang.org/go)
    17  [![Documentation](https://img.shields.io/badge/CUE-Docs-0066ff)](https://cuelang.org/docs/)
    18  [![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)
    19  [![Go 1.23+](https://img.shields.io/badge/go-1.23-9cf.svg)](https://golang.org/dl/)
    20  [![platforms](https://img.shields.io/badge/platforms-linux|windows|macos-inactive.svg)]()
    21  [![Docker Image](https://img.shields.io/docker/v/cuelang/cue?sort=semver&label=docker)](https://hub.docker.com/r/cuelang/cue)
    22  
    23  # CUE - _Configure, Unify, Execute_
    24  
    25  CUE makes it easy to validate data, write schemas,
    26  and ensure configurations align with policies.
    27  
    28  CUE works with a wide range of tools and formats that you're already using
    29  such as Go, JSON, YAML, OpenAPI, and JSON Schema.
    30  
    31  For more information and documentation, including __tutorials and guides__, see [cuelang.org](https://cuelang.org).
    32  
    33  ### Download and Install
    34  
    35  The full range of installation methods for the `cue` command are listed on the
    36  [cuelang.org site](https://cuelang.org/docs/introduction/installation/),
    37  including the official container image suitable for use with Docker.
    38  Here are two common ways to install the command:
    39  
    40  #### Release builds
    41  
    42  Download the [latest release](https://github.com/cue-lang/cue/releases/latest/) from GitHub.
    43  
    44  #### Install from Source
    45  
    46  You need [Go 1.23 or later](https://go.dev/doc/install) to install CUE from source:
    47  
    48  	go install cuelang.org/go/cmd/cue@latest
    49  
    50  You can also clone the repository and build it directly via `go install ./cmd/cue`.
    51  Note that local builds [lack version information](https://go.dev/issue/50603),
    52  so you should inject the version string when building a release, such as:
    53  
    54  	git switch -d v0.11.0
    55  	go install -ldflags='-X cuelang.org/go/cmd/cue/cmd.version=v0.11.0' ./cmd/cue
    56  
    57  ### Learning CUE
    58  
    59  The fastest way to learn the basics is to follow the [tour on the website](https://cuelang.org/docs/tour/).
    60  
    61  More documentation including various tutorials can be found [on the website](https://cuelang.org/docs/).
    62  
    63  ### References
    64  
    65  - [Language Specification](https://cuelang.org/docs/reference/spec/): the official CUE Language specification
    66  - [Go API](https://pkg.go.dev/cuelang.org/go/cue): the Go API on pkg.go.dev
    67  - [Builtin packages](https://pkg.go.dev/cuelang.org/go/pkg): builtin functions available from CUE programs
    68  - [`cue` CLI](https://cuelang.org/docs/reference/cli/): the `cue` command line interface
    69  
    70  ### Go release support policy
    71  
    72  As a general rule, we support the two most recent major releases of Go,
    73  matching Go's [security policy](https://go.dev/doc/security/policy).
    74  For example, if CUE v0.7.0 is released when Go's latest version is 1.21.5,
    75  v0.7.x including any following bugfix releases will require Go 1.20 or later.
    76  
    77  ### Contributing
    78  
    79  To contribute, please read the [Contribution Guide](CONTRIBUTING.md).
    80  
    81  ## Code of Conduct
    82  
    83  Guidelines for participating in CUE community spaces and a reporting process for
    84  handling issues can be found in the [Code of Conduct](https://cuelang.org/docs/reference/code-of-conduct/).
    85  
    86  ## Contact
    87  
    88  - Ask questions via [GitHub Discussions](https://github.com/cue-lang/cue/discussions)
    89  - Chat with us on [Slack](https://cuelang.org/s/slack) and [Discord](https://cuelang.org/s/discord)
    90  - Subscribe to our [Community Calendar](https://cuelang.org/s/community-calendar) for community updates, demos, office hours, etc
    91  
    92  ---
    93  
    94  Unless otherwise noted, the CUE source files are distributed
    95  under the Apache 2.0 license found in the LICENSE file.