@@ -56,7 +56,7 @@ trait ViashCommand {
5656 )
5757 val config = registerTrailArg[String ](
5858 name = " config" ,
59- descr = " A viash config file (example: `config.vsh.yaml`). This argument can also be a script with the config as a header." ,
59+ descr = " A Viash config file (example: `config.vsh.yaml`). This argument can also be a script with the config as a header." ,
6060 default = Some (" config.vsh.yaml" ),
6161 required = true
6262 )
@@ -65,7 +65,7 @@ trait ViashCommand {
6565 short = Some ('c' ),
6666 default = Some (Nil ),
6767
68- descr = " Modify a viash config at runtime using @[dynamic config modding](config_mod)."
68+ descr = " Modify a Viash config at runtime using @[dynamic config modding](config_mod)."
6969 )
7070}
7171trait ViashRunner {
@@ -110,7 +110,7 @@ trait ViashNs {
110110 val src = registerOpt[String ](
111111 name = " src" ,
112112 short = Some ('s' ),
113- descr = " A source directory containing viash config files, possibly structured in a hierarchical folder structure. Default: src/." ,
113+ descr = " A source directory containing Viash config files, possibly structured in a hierarchical folder structure. Default: src/." ,
114114 default = None
115115 )
116116 val platform = registerOpt[String ](
@@ -153,7 +153,7 @@ trait ViashNs {
153153 name = " config_mod" ,
154154 short = Some ('c' ),
155155 default = Some (Nil ),
156- descr = " Modify a viash config at runtime using @[dynamic config modding](config_mod)."
156+ descr = " Modify a Viash config at runtime using @[dynamic config modding](config_mod)."
157157 )
158158}
159159
@@ -237,12 +237,14 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
237237 val run = new DocumentedSubcommand (" run" ) with ViashCommand with WithTemporary with ViashRunner with ViashLogger {
238238 banner(
239239 " viash run" ,
240- " Executes a viash component from the provided viash config file. viash generates a temporary executable and immediately executes it with the given parameters." ,
241- " viash run config.vsh.yaml [-p docker] [-k true/false] -- [arguments for script]" )
240+ """ Executes a Viash component from the provided Viash config file. Viash generates a temporary executable and immediately executes it with the given parameters.
241+ |Alternatively, a component can be fetched directly for Viash-Hub.""" .stripMargin,
242+ """ viash run config.vsh.yaml [-p docker] [-k true/false] -- [arguments for script]
243+ |viash run vsh://toolbox/v0.1.0/yq -- --input input.yaml --output output.yaml --eval '.name'""" .stripMargin)
242244
243245 footer(
244246 s """ -- param1 param2 ... Extra parameters to be passed to the component itself.
245- | -- is used to separate viash arguments from the arguments
247+ | -- is used to separate Viash arguments from the arguments
246248 | of the component.
247249 |
248250 |The temporary directory can be altered by setting the VIASH_TEMP directory. Example:
@@ -253,7 +255,7 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
253255 object build extends DocumentedSubcommand (" build" ) with ViashCommand with ViashLogger {
254256 banner(
255257 " viash build" ,
256- " Build an executable from the provided viash config file." ,
258+ " Build an executable from the provided Viash config file." ,
257259 " viash build config.vsh.yaml -o output [-p docker] [-m] [-s]" )
258260
259261 val output = registerOpt[String ](
@@ -279,7 +281,7 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
279281 object test extends DocumentedSubcommand (" test" ) with ViashCommand with WithTemporary with ViashRunner with ViashLogger {
280282 banner(
281283 " viash test" ,
282- " Test the component using the tests defined in the viash config file." ,
284+ " Test the component using the tests defined in the Viash config file." ,
283285 " viash test config.vsh.yaml [-p docker] [-k true/false] [--setup cachedbuild]" )
284286
285287 val setup = registerOpt[String ](
@@ -347,7 +349,7 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
347349 object build extends DocumentedSubcommand (" build" ) with ViashNs with ViashNsBuild with ViashLogger {
348350 banner(
349351 " viash ns build" ,
350- " Build a namespace from many viash config files." ,
352+ " Build a namespace from many Viash config files." ,
351353 " viash ns build [-n nmspc] [-s src] [-t target] [-p docker] [--setup] [--push] [--parallel] [--flatten]" )
352354
353355 val setup = registerOpt[String ](
@@ -371,7 +373,7 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
371373 object test extends DocumentedSubcommand (" test" ) with ViashNs with WithTemporary with ViashRunner with ViashLogger {
372374 banner(
373375 " viash ns test" ,
374- " Test a namespace containing many viash config files." ,
376+ " Test a namespace containing many Viash config files." ,
375377 " viash ns test [-n nmspc] [-s src] [-p docker] [--parallel] [--tsv file.tsv] [--setup cachedbuild] [--append]" )
376378
377379 val setup = registerOpt[String ](
@@ -408,7 +410,7 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
408410 object list extends DocumentedSubcommand (" list" ) with ViashNs with ViashLogger {
409411 banner(
410412 " viash ns list" ,
411- " List a namespace containing many viash config files." ,
413+ " List a namespace containing many Viash config files." ,
412414 " viash ns list [-n nmspc] [-s src] [-p docker]" )
413415
414416 val format = registerChoice(
@@ -491,7 +493,7 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
491493
492494 val cmd = registerTrailArg[String ](
493495 name = " cmd" ,
494- descr = " The command to execute for each viash config file in the namespace." ,
496+ descr = " The command to execute for each Viash config file in the namespace." ,
495497 required = true
496498 )
497499 }
@@ -511,8 +513,8 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
511513 object resource extends DocumentedSubcommand (" resource" ) with ViashLogger {
512514 banner(
513515 " viash export resource" ,
514- """ Export an internal resource file""" .stripMargin ,
515- """ viash export resource runners/nextflow/WorkflowHelper.nf [--output foo.nf]""" .stripMargin
516+ """ Export an internal resource file""" ,
517+ """ viash export resource runners/nextflow/WorkflowHelper.nf [--output foo.nf]"""
516518 )
517519
518520 val path = registerTrailArg[String ](
@@ -531,8 +533,8 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
531533 object cli_schema extends DocumentedSubcommand (" cli_schema" ) with ViashLogger {
532534 banner(
533535 " viash export cli_schema" ,
534- """ Export the schema of the Viash CLI as a JSON""" .stripMargin ,
535- """ viash export cli_schema [--output file.json] [--format json]""" .stripMargin
536+ """ Export the schema of the Viash CLI as a JSON""" ,
537+ """ viash export cli_schema [--output file.json] [--format json]"""
536538 )
537539 val output = registerOpt[String ](
538540 name = " output" ,
@@ -551,8 +553,8 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
551553 object cli_autocomplete extends DocumentedSubcommand (" cli_autocomplete" ) with ViashLogger {
552554 banner(
553555 " viash export bash_autocomplete" ,
554- """ Export the autocomplete script as to be used in Bash or Zsh""" .stripMargin ,
555- """ viash export bash_autocomplete [--output viash_autocomplete_bash] [--zsh]""" .stripMargin
556+ """ Export the autocomplete script as to be used in Bash or Zsh""" ,
557+ """ viash export bash_autocomplete [--output viash_autocomplete_bash] [--zsh]"""
556558 )
557559 val output = registerOpt[String ](
558560 name = " output" ,
@@ -571,8 +573,8 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
571573 object config_schema extends DocumentedSubcommand (" config_schema" ) with ViashLogger {
572574 banner(
573575 " viash export config_schema" ,
574- """ Export the schema of a Viash config as a JSON""" .stripMargin ,
575- """ viash export config_schema [--output file.json] [--format json]""" .stripMargin
576+ """ Export the schema of a Viash config as a JSON""" ,
577+ """ viash export config_schema [--output file.json] [--format json]"""
576578 )
577579 val output = registerOpt[String ](
578580 name = " output" ,
@@ -591,8 +593,8 @@ class CLIConf(arguments: Seq[String]) extends ScallopConf(arguments) with Loggin
591593 object json_schema extends DocumentedSubcommand (" json_schema" ) with ViashLogger {
592594 banner(
593595 " viash export json_schema" ,
594- """ Export the json schema to validate a Viash config""" .stripMargin ,
595- """ viash export json_schema [--output file.json] [--format json]""" .stripMargin
596+ """ Export the json schema to validate a Viash config""" ,
597+ """ viash export json_schema [--output file.json] [--format json]"""
596598 )
597599 val output = registerOpt[String ](
598600 name = " output" ,
0 commit comments