From 314fe60d045883dcf5197d97b8fbebc2a0e01e41 Mon Sep 17 00:00:00 2001 From: Roger Peppe Date: Fri, 9 Feb 2024 17:43:17 +0000 Subject: [PATCH] reference: add new CLI help entries This adds the following new CLI help entries: * cue help environment * cue mod publish * cue mod tidy After adding the requisite entries to content/docs/reference/cli/commands.cue, the rest of the CL was generated by running: go generate ./... _scripts/runPreprocessor.bash execute Preview-Path: /docs/reference/cli/cue-environment Preview-Path: /docs/reference/cli/cue-mod-tidy Preview-Path: /docs/reference/cli/cue-mod-publish Change-Id: Ifaed2de27007f9f322e0fbc52f3612c641c49314 Signed-off-by: Roger Peppe Reviewed-on: https://review.gerrithub.io/c/cue-lang/cuelang.org/+/1176651 TryBot-Result: CUEcueckoo --- content/docs/reference/cli/commands.cue | 47 ++++++----- .../docs/reference/cli/cue-environment/en.md | 10 +++ .../cli/cue-environment/gen_cache.cue | 83 +++++++++++++++++++ .../reference/cli/cue-environment/page.cue | 4 + .../docs/reference/cli/cue-mod-publish/en.md | 10 +++ .../cli/cue-mod-publish/gen_cache.cue | 42 ++++++++++ .../reference/cli/cue-mod-publish/page.cue | 4 + content/docs/reference/cli/cue-mod-tidy/en.md | 10 +++ .../reference/cli/cue-mod-tidy/gen_cache.cue | 41 +++++++++ .../docs/reference/cli/cue-mod-tidy/page.cue | 4 + .../reference/cli/cue-environment/index.md | 66 +++++++++++++++ .../reference/cli/cue-mod-publish/index.md | 25 ++++++ .../docs/reference/cli/cue-mod-tidy/index.md | 24 ++++++ 13 files changed, 348 insertions(+), 22 deletions(-) create mode 100644 content/docs/reference/cli/cue-environment/en.md create mode 100644 content/docs/reference/cli/cue-environment/gen_cache.cue create mode 100644 content/docs/reference/cli/cue-environment/page.cue create mode 100644 content/docs/reference/cli/cue-mod-publish/en.md create mode 100644 content/docs/reference/cli/cue-mod-publish/gen_cache.cue create mode 100644 content/docs/reference/cli/cue-mod-publish/page.cue create mode 100644 content/docs/reference/cli/cue-mod-tidy/en.md create mode 100644 content/docs/reference/cli/cue-mod-tidy/gen_cache.cue create mode 100644 content/docs/reference/cli/cue-mod-tidy/page.cue create mode 100644 hugo/content/en/docs/reference/cli/cue-environment/index.md create mode 100644 hugo/content/en/docs/reference/cli/cue-mod-publish/index.md create mode 100644 hugo/content/en/docs/reference/cli/cue-mod-tidy/index.md diff --git a/content/docs/reference/cli/commands.cue b/content/docs/reference/cli/commands.cue index 108b35d3c..dfd4d822a 100644 --- a/content/docs/reference/cli/commands.cue +++ b/content/docs/reference/cli/commands.cue @@ -35,26 +35,29 @@ cue: { execCmd: "cue help" title: "cue" } - version: _ - cmd: _ - commands: _ - completion: _ - def: _ - eval: _ - export: _ - filetypes: _ - fix: _ - flags: _ - fmt: _ - get: _ - "get go": _ - help: _ - import: _ - injection: _ - inputs: _ - mod: _ - "mod init": _ - trim: _ - version: _ - vet: _ + version: _ + cmd: _ + commands: _ + completion: _ + def: _ + environment: _ + eval: _ + export: _ + filetypes: _ + fix: _ + flags: _ + fmt: _ + get: _ + "get go": _ + help: _ + import: _ + injection: _ + inputs: _ + mod: _ + "mod init": _ + "mod publish": _ + "mod tidy": _ + trim: _ + version: _ + vet: _ } diff --git a/content/docs/reference/cli/cue-environment/en.md b/content/docs/reference/cli/cue-environment/en.md new file mode 100644 index 000000000..fefc78c7c --- /dev/null +++ b/content/docs/reference/cli/cue-environment/en.md @@ -0,0 +1,10 @@ +--- +WARNING: "Code generated site_tool.cue; DO NOT EDIT." +title: "cue environment" +tags: +- cue command +--- + +{{{with script "en" "cue cli help text"}}} +cue help environment +{{{end}}} diff --git a/content/docs/reference/cli/cue-environment/gen_cache.cue b/content/docs/reference/cli/cue-environment/gen_cache.cue new file mode 100644 index 000000000..590744602 --- /dev/null +++ b/content/docs/reference/cli/cue-environment/gen_cache.cue @@ -0,0 +1,83 @@ +package site +{ + content: { + docs: { + reference: { + cli: { + "cue-environment": { + page: { + cache: { + multi_step: { + "IEJR2KECMQK9DLHKR9I5T0DO48271MD23AHA1HCOA0F3JQGDLHS0====": [{ + doc: "" + cmd: "cue help environment" + exitCode: 0 + output: """ + The cue command consults environment variables for configuration. + If an environment variable is unset or empty, it uses a sensible default + setting. + + \tCUE_CONFIG_DIR + \t\tThe directory where the cue command keeps configuration and state files. + \t\tThis defaults to a directory for user-specific configuration data, such as: + + \t\t\t"$XDG_CONFIG_HOME/cue" or "$HOME/.config/cue" on Linux + \t\t\t"$HOME/Library/Application Support" on MacOS + \t\t\t"%AppData%/cue" on Windows + + \tCUE_REGISTRY + \t\tA comma-separated list specifying which registry to use for + \t\tdownloading and publishing modules. A registry is specifed + \t\tas follows: + + \t\t\t[modulePrefix=]hostname[:port][/repoPrefix][+insecure] + + \t\tThe optional modulePrefix specifes that all modules with the + \t\tgiven prefix wil use the associated registry. If there are + \t\tmultiple registries with a prefix, the longest matching prefix wins. + + \t\tThe hostname holds the OCI registry host (in square brackets if it's + \t\tan IPv6 address). The repoPrefix holds a prefix to use in front + \t\tof all repositories in the registry. If there's a "+insecure" + \t\tsuffix, it specifies that an insecure HTTP connection should be + \t\tused to this registry; otherwise the default is secure except + \t\tfor localhost addresses. + + \t\tFor example, given: + \t\t\tCUE_REGISTRY=public-registry.com,github.com/acmecorp=registry.acme.com:6000/modules + \t\tthe module named github.com/foo/bar will be fetched + \t\tfrom public-registry.com; a module named + \t\tgithub.com/acmecorp/somemodule will be fetched from the + \t\tmodules/github.com/acmecorp/somemodule repository in the host + \t\tregistry.acme.com at port 6000. + + \t\tRequires that CUE_EXPERIMENT=modules is enabled. + + \tCUE_MODCACHE + \t\tThe directory where the cue command will store downloaded + \t\tmodules. + + \t\tRequires that CUE_EXPERIMENT=modules is enabled. + + \tCUE_EXPERIMENT + \t\tComma-separated list of experiments to enable or disable. + \t\tThe list of available experiments may change arbitrarily over + \t\ttime. See exp.go in package cuelang.org/go/internal/cueexperiment for + \t\tcurrently valid values. + + \t\tWarning: This variable is provided for the development and + \t\ttesting of the cue commands itself. Use beyond that purpose + \t\tis unsupported. + + + """ + }] + } + } + } + } + } + } + } + } +} diff --git a/content/docs/reference/cli/cue-environment/page.cue b/content/docs/reference/cli/cue-environment/page.cue new file mode 100644 index 000000000..eb382ef8f --- /dev/null +++ b/content/docs/reference/cli/cue-environment/page.cue @@ -0,0 +1,4 @@ +// Code generated site_tool.cue; DO NOT EDIT. +package site + +{"content":{"docs":{"reference":{"cli":{"cue-environment":{}}}}}} diff --git a/content/docs/reference/cli/cue-mod-publish/en.md b/content/docs/reference/cli/cue-mod-publish/en.md new file mode 100644 index 000000000..953544e19 --- /dev/null +++ b/content/docs/reference/cli/cue-mod-publish/en.md @@ -0,0 +1,10 @@ +--- +WARNING: "Code generated site_tool.cue; DO NOT EDIT." +title: "cue mod publish" +tags: +- cue command +--- + +{{{with script "en" "cue cli help text"}}} +cue help mod publish +{{{end}}} diff --git a/content/docs/reference/cli/cue-mod-publish/gen_cache.cue b/content/docs/reference/cli/cue-mod-publish/gen_cache.cue new file mode 100644 index 000000000..339639a03 --- /dev/null +++ b/content/docs/reference/cli/cue-mod-publish/gen_cache.cue @@ -0,0 +1,42 @@ +package site +{ + content: { + docs: { + reference: { + cli: { + "cue-mod-publish": { + page: { + cache: { + multi_step: { + "MPFLQUKETE49RQ507K6LB74V4KD91BUVR7C90DFGGEHJJPGS8FA0====": [{ + doc: "" + cmd: "cue help mod publish" + exitCode: 0 + output: """ + WARNING: THIS COMMAND IS EXPERIMENTAL. + + Publish the current module to an OCI registry. + Also note that this command does no dependency or other checks at the moment. + + Usage: + cue mod publish [flags] + + Global Flags: + -E, --all-errors print all available errors + -i, --ignore proceed in the presence of errors + -s, --simplify simplify output + --strict report errors for lossy mappings + --trace trace computation + -v, --verbose print information about progress + + """ + }] + } + } + } + } + } + } + } + } +} diff --git a/content/docs/reference/cli/cue-mod-publish/page.cue b/content/docs/reference/cli/cue-mod-publish/page.cue new file mode 100644 index 000000000..3ceefacd9 --- /dev/null +++ b/content/docs/reference/cli/cue-mod-publish/page.cue @@ -0,0 +1,4 @@ +// Code generated site_tool.cue; DO NOT EDIT. +package site + +{"content":{"docs":{"reference":{"cli":{"cue-mod-publish":{}}}}}} diff --git a/content/docs/reference/cli/cue-mod-tidy/en.md b/content/docs/reference/cli/cue-mod-tidy/en.md new file mode 100644 index 000000000..b9a37da75 --- /dev/null +++ b/content/docs/reference/cli/cue-mod-tidy/en.md @@ -0,0 +1,10 @@ +--- +WARNING: "Code generated site_tool.cue; DO NOT EDIT." +title: "cue mod tidy" +tags: +- cue command +--- + +{{{with script "en" "cue cli help text"}}} +cue help mod tidy +{{{end}}} diff --git a/content/docs/reference/cli/cue-mod-tidy/gen_cache.cue b/content/docs/reference/cli/cue-mod-tidy/gen_cache.cue new file mode 100644 index 000000000..a2999e17c --- /dev/null +++ b/content/docs/reference/cli/cue-mod-tidy/gen_cache.cue @@ -0,0 +1,41 @@ +package site +{ + content: { + docs: { + reference: { + cli: { + "cue-mod-tidy": { + page: { + cache: { + multi_step: { + "KAOUUK8P8ATM22AMFKIKEDHO8GAL5HUNTRCHMHTR8O0OOLAOPKK0====": [{ + doc: "" + cmd: "cue help mod tidy" + exitCode: 0 + output: """ + WARNING: THIS COMMAND IS EXPERIMENTAL. + + Currently this command must be run in the module's root directory. + + Usage: + cue mod tidy [flags] + + Global Flags: + -E, --all-errors print all available errors + -i, --ignore proceed in the presence of errors + -s, --simplify simplify output + --strict report errors for lossy mappings + --trace trace computation + -v, --verbose print information about progress + + """ + }] + } + } + } + } + } + } + } + } +} diff --git a/content/docs/reference/cli/cue-mod-tidy/page.cue b/content/docs/reference/cli/cue-mod-tidy/page.cue new file mode 100644 index 000000000..b33d27258 --- /dev/null +++ b/content/docs/reference/cli/cue-mod-tidy/page.cue @@ -0,0 +1,4 @@ +// Code generated site_tool.cue; DO NOT EDIT. +package site + +{"content":{"docs":{"reference":{"cli":{"cue-mod-tidy":{}}}}}} diff --git a/hugo/content/en/docs/reference/cli/cue-environment/index.md b/hugo/content/en/docs/reference/cli/cue-environment/index.md new file mode 100644 index 000000000..488d294f1 --- /dev/null +++ b/hugo/content/en/docs/reference/cli/cue-environment/index.md @@ -0,0 +1,66 @@ +--- +WARNING: "Code generated site_tool.cue; DO NOT EDIT." +title: "cue environment" +tags: +- cue command +--- + +```text { title="TERMINAL" codeToCopy="Y3VlIGhlbHAgZW52aXJvbm1lbnQK" } +$ cue help environment +The cue command consults environment variables for configuration. +If an environment variable is unset or empty, it uses a sensible default +setting. + + CUE_CONFIG_DIR + The directory where the cue command keeps configuration and state files. + This defaults to a directory for user-specific configuration data, such as: + + "$XDG_CONFIG_HOME/cue" or "$HOME/.config/cue" on Linux + "$HOME/Library/Application Support" on MacOS + "%AppData%/cue" on Windows + + CUE_REGISTRY + A comma-separated list specifying which registry to use for + downloading and publishing modules. A registry is specifed + as follows: + + [modulePrefix=]hostname[:port][/repoPrefix][+insecure] + + The optional modulePrefix specifes that all modules with the + given prefix wil use the associated registry. If there are + multiple registries with a prefix, the longest matching prefix wins. + + The hostname holds the OCI registry host (in square brackets if it's + an IPv6 address). The repoPrefix holds a prefix to use in front + of all repositories in the registry. If there's a "+insecure" + suffix, it specifies that an insecure HTTP connection should be + used to this registry; otherwise the default is secure except + for localhost addresses. + + For example, given: + CUE_REGISTRY=public-registry.com,github.com/acmecorp=registry.acme.com:6000/modules + the module named github.com/foo/bar will be fetched + from public-registry.com; a module named + github.com/acmecorp/somemodule will be fetched from the + modules/github.com/acmecorp/somemodule repository in the host + registry.acme.com at port 6000. + + Requires that CUE_EXPERIMENT=modules is enabled. + + CUE_MODCACHE + The directory where the cue command will store downloaded + modules. + + Requires that CUE_EXPERIMENT=modules is enabled. + + CUE_EXPERIMENT + Comma-separated list of experiments to enable or disable. + The list of available experiments may change arbitrarily over + time. See exp.go in package cuelang.org/go/internal/cueexperiment for + currently valid values. + + Warning: This variable is provided for the development and + testing of the cue commands itself. Use beyond that purpose + is unsupported. + +``` diff --git a/hugo/content/en/docs/reference/cli/cue-mod-publish/index.md b/hugo/content/en/docs/reference/cli/cue-mod-publish/index.md new file mode 100644 index 000000000..99c6178c5 --- /dev/null +++ b/hugo/content/en/docs/reference/cli/cue-mod-publish/index.md @@ -0,0 +1,25 @@ +--- +WARNING: "Code generated site_tool.cue; DO NOT EDIT." +title: "cue mod publish" +tags: +- cue command +--- + +```text { title="TERMINAL" codeToCopy="Y3VlIGhlbHAgbW9kIHB1Ymxpc2gK" } +$ cue help mod publish +WARNING: THIS COMMAND IS EXPERIMENTAL. + +Publish the current module to an OCI registry. +Also note that this command does no dependency or other checks at the moment. + +Usage: + cue mod publish [flags] + +Global Flags: + -E, --all-errors print all available errors + -i, --ignore proceed in the presence of errors + -s, --simplify simplify output + --strict report errors for lossy mappings + --trace trace computation + -v, --verbose print information about progress +``` diff --git a/hugo/content/en/docs/reference/cli/cue-mod-tidy/index.md b/hugo/content/en/docs/reference/cli/cue-mod-tidy/index.md new file mode 100644 index 000000000..c05b2a00c --- /dev/null +++ b/hugo/content/en/docs/reference/cli/cue-mod-tidy/index.md @@ -0,0 +1,24 @@ +--- +WARNING: "Code generated site_tool.cue; DO NOT EDIT." +title: "cue mod tidy" +tags: +- cue command +--- + +```text { title="TERMINAL" codeToCopy="Y3VlIGhlbHAgbW9kIHRpZHkK" } +$ cue help mod tidy +WARNING: THIS COMMAND IS EXPERIMENTAL. + +Currently this command must be run in the module's root directory. + +Usage: + cue mod tidy [flags] + +Global Flags: + -E, --all-errors print all available errors + -i, --ignore proceed in the presence of errors + -s, --simplify simplify output + --strict report errors for lossy mappings + --trace trace computation + -v, --verbose print information about progress +```