From d4d3b1c9ddbb807d79900541de896b37fa146bca Mon Sep 17 00:00:00 2001 From: Jianbo Sun Date: Wed, 3 Aug 2022 18:22:50 +0800 Subject: [PATCH] Chore: fix cli description to remove html tag format Signed-off-by: Jianbo Sun --- references/cli/def.go | 2 +- references/cli/dryrun.go | 4 ++-- references/cli/velaql.go | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/references/cli/def.go b/references/cli/def.go index df2af9209..264db259d 100644 --- a/references/cli/def.go +++ b/references/cli/def.go @@ -857,7 +857,7 @@ func NewDefinitionApplyCommand(c common.Args, streams util.IOStreams) *cobra.Com "# Command below will convert the ./defs/my-trait.cue file to kubernetes CRD object and print it without applying it to kubernetes\n" + "> vela def apply ./defs/my-trait.cue --dry-run" + "# Apply a CUE from URL \n" + - "> vela def apply https:///my-trait.cue --dry-run" + + "> vela def apply https://my-host-to-def/my-trait.cue --dry-run" + "# Apply a CUE from stdin \n" + "> vela def apply -", Args: cobra.ExactValidArgs(1), diff --git a/references/cli/dryrun.go b/references/cli/dryrun.go index 5bf1d7a5d..c90ccb051 100644 --- a/references/cli/dryrun.go +++ b/references/cli/dryrun.go @@ -56,10 +56,10 @@ func NewDryRunCommand(c common.Args, ioStreams cmdutil.IOStreams) *cobra.Command DisableFlagsInUseLine: true, Short: "Dry Run an application, and output the K8s resources as result to stdout", Long: `Dry-run application locally, render the Kubernetes resources as result to stdout. - vela dry-run -d -f /path/to/app.yaml + vela dry-run -d /definition/directory/or/file/ -f /path/to/app.yaml You can also specify a remote url for app: - vela dry-run -d -f https:///app.yaml + vela dry-run -d /definition/directory/or/file/ -f https://remote-host/app.yaml `, Example: "vela dry-run", Annotations: map[string]string{ diff --git a/references/cli/velaql.go b/references/cli/velaql.go index 622aec5ce..ec6c08547 100644 --- a/references/cli/velaql.go +++ b/references/cli/velaql.go @@ -56,15 +56,15 @@ func NewQlCommand(c common.Args, order string, ioStreams util.IOStreams) *cobra. Use: "ql", Short: "Show result of executing velaQL.", Long: `Show result of executing velaQL, use it like: - vela ql --query "{=,=} + vela ql --query "inner-view-name{param1=value1,param2=value2}" vela ql --file ./ql.cue`, Example: ` Users can query with a query statement: - vela ql --query "{=,=}" + vela ql --query "inner-view-name{param1=value1,param2=value2}" Query by a ql file: vela ql --file ./ql.cue Query by a ql file from remote url: - vela ql --file https:///ql.cue + vela ql --file https://my.host.to.cue/ql.cue Query by a ql file from stdin: cat ./ql.cue | vela ql --file -