blob: 0f7669baf473062f88baa1f65338e0fb89260237 [file] [log] [blame]
// 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package cmd
import (
// newExportCmd creates and export command
func newExportCmd(c *Command) *cobra.Command {
cmd := &cobra.Command{
Use: "export",
Short: "output data in a standard format",
Long: `export evaluates the configuration found in the current
directory and prints the emit value to stdout.
Evaluated and emit
# a single file
cue export config.cue
# multiple files: these are combined at the top-level. Order doesn't matter.
cue export file1.cue foo/file2.cue
# all files within the "mypkg" package: this includes all files in the
# current directory and its ancestor directories that are marked with the
# same package.
cue export -p cloud
# the -p flag can be omitted if the directory only contains files for
# the "mypkg" package.
cue export
Emit value:
For CUE files, the generated configuration is derived from the top-level
single expression, the emit value. For example, the file
// config.cue
arg1: 1
arg2: "my string"
a: arg1
b: arg2
yields the following JSON:
"a": 1,
"b", "my string"
In absence of arguments, the current directory is loaded as a package instance.
A package instance for a directory contains all files in the directory and its
ancestor directories, up to the module root, belonging to the same package.
If the package is not explicitly defined by the '-p' flag, it must be uniquely
defined by the files in the current directory.
The following formats are recognized:
json output as JSON
Outputs any CUE value.
text output as raw text
The evaluated value must be of type string.
yaml output as YAML
Outputs any CUE value.
RunE: mkRunE(c, runExport),
addOutFlags(cmd.Flags(), true)
cmd.Flags().Bool(string(flagEscape), false, "use HTML escaping")
cmd.Flags().StringArrayP(string(flagExpression), "e", nil, "export this expression only")
cmd.Flags().StringArrayP(string(flagInject), "t", nil,
"set the value of a tagged field")
return cmd
func runExport(cmd *Command, args []string) error {
b, err := parseArgs(cmd, args, &config{outMode: filetypes.Export})
exitOnErr(cmd, err, true)
enc, err := encoding.NewEncoder(b.outFile, b.encConfig)
exitOnErr(cmd, err, true)
defer enc.Close()
iter := b.instances()
defer iter.close()
for iter.scan() {
inst := iter.instance()
err = enc.Encode(inst)
exitOnErr(cmd, err, true)
exitOnErr(cmd, iter.err(), true)
return nil