diff --git a/cmd/meroxa/root/apps/deploy.go b/cmd/meroxa/root/apps/deploy.go index a16eba1f1..dd4ad161d 100644 --- a/cmd/meroxa/root/apps/deploy.go +++ b/cmd/meroxa/root/apps/deploy.go @@ -89,11 +89,13 @@ func (*Deploy) Usage() string { func (*Deploy) Docs() builder.Docs { return builder.Docs{ Short: "Deploy a Meroxa Data Application", - Long: "This command will deploy the application specified in `--path`" + - "(or current working directory if not specified) to our Meroxa Platform." + - "If deployment was successful, you should expect an application you'll be able to fully manage", - Example: "meroxa apps deploy # assumes you run it from the app directory\n" + - "meroxa apps deploy --path ./my-app", + Long: `This command will deploy the application specified in '--path' +(or current working directory if not specified) to our Meroxa Platform. +If deployment was successful, you should expect an application you'll be able to fully manage +`, + Example: `meroxa apps deploy # assumes you run it from the app directory +meroxa apps deploy --path ./my-app +`, } } diff --git a/cmd/meroxa/root/apps/init.go b/cmd/meroxa/root/apps/init.go index 5b20d41ff..b2bdaf906 100644 --- a/cmd/meroxa/root/apps/init.go +++ b/cmd/meroxa/root/apps/init.go @@ -47,11 +47,12 @@ func (*Init) Usage() string { func (*Init) Docs() builder.Docs { return builder.Docs{ Short: "Initialize a Meroxa Data Application", - Example: "meroxa apps init my-app --path ~/code --lang js" + - "meroxa apps init my-app --lang go # will be initialized in a dir called my-app in the current directory" + - "meroxa apps init my-app --lang go --path $GOPATH/src/github.com/my.org" + - "meroxa apps init my-app --lang go --skip-mod-init # will not initialize the new go module" + - "meroxa apps init my-app --lang go --mod-vendor # will initialize the new go module and download dependencies to the vendor directory", + Example: `meroxa apps init my-app --path ~/code --lang js +meroxa apps init my-app --lang go # will be initialized in a dir called my-app in the current directory +meroxa apps init my-app --lang go --skip-mod-init # will not initialize the new go module +meroxa apps init my-app --lang go --mod-vendor # will initialize the new go module and download dependencies to the vendor directory +meroxa apps init my-app --lang go --path $GOPATH/src/github.com/my.org +`, } } diff --git a/cmd/meroxa/root/apps/run.go b/cmd/meroxa/root/apps/run.go index 5bc1ad02c..b4adf73c3 100644 --- a/cmd/meroxa/root/apps/run.go +++ b/cmd/meroxa/root/apps/run.go @@ -53,11 +53,10 @@ func (*Run) Usage() string { func (*Run) Docs() builder.Docs { return builder.Docs{ Short: "Execute a Meroxa Data Application locally", - Long: "meroxa apps run will build your app locally to then run it\n" + - "locally on --path.", - Example: "meroxa apps run # assumes you run it from the app directory\n" + - "meroxa apps run --path ../js-demo --lang js # in case you didn't specify lang on your app.json" + - "meroxa apps run --path ../go-demo # it'll use lang defined in your app.json", + Long: "meroxa apps run will build your app locally to then run it locally in --path.", + Example: `meroxa apps run # assumes you run it from the app directory +meroxa apps run --path ../go-demo # it'll use lang defined in your app.json +`, } }