Skip to content

Commit

Permalink
change single dash long arguments to double dash long arguments
Browse files Browse the repository at this point in the history 
with threagile version > 0.9.0, a single dash for long arguments do not
work anymore
  • Loading branch information
@CMon
CMon committed Apr 15, 2024
1 parent 22c400c commit 4db68f3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,30 +32,30 @@ The easiest way to execute Threagile on the commandline is via its Docker contai
Examples:

If you want to create an example model (via docker) as a starting point to learn about Threagile just run:
docker run --rm -it -v "$(pwd)":app/work threagile/threagile create-example-model -output app/work
docker run --rm -it -v "$(pwd)":app/work threagile/threagile create-example-model --output app/work

If you want to create a minimal stub model (via docker) as a starting point for your own model just run:
docker run --rm -it -v "$(pwd)":app/work threagile/threagile create-stub-model -output app/work
docker run --rm -it -v "$(pwd)":app/work threagile/threagile create-stub-model --output app/work

If you want to execute Threagile on a model yaml file (via docker):
docker run --rm -it -v "$(pwd)":app/work threagile/threagile analyze-model -verbose -model -output app/work
docker run --rm -it -v "$(pwd)":app/work threagile/threagile analyze-model --verbose --model --output app/work

If you want to execute Threagile in interactive mode (via docker):
docker run --rm -it -v "$(pwd)":app/work threagile/threagile -i -verbose -model -output app/work
docker run --rm -it -v "$(pwd)":app/work threagile/threagile -i --verbose --model --output app/work

If you want to run Threagile as a server (REST API) on some port (here 8080):
docker run --rm -it --shm-size=256m -p 8080:8080 --name --mount 'type=volume,src=threagile-storage,dst=/data,readonly=false' threagile/threagile server --server-port 8080

If you want to find out about the different enum values usable in the model yaml file:
docker run --rm -it threagile/threagile list-types

If you want to use some nice editing help (syntax validation, autocompletion, and live templates) in your favourite IDE: docker run --rm -it -v "$(pwd)":app/work threagile/threagile create-editing-support -output app/work
If you want to use some nice editing help (syntax validation, autocompletion, and live templates) in your favourite IDE: docker run --rm -it -v "$(pwd)":app/work threagile/threagile create-editing-support --output app/work

If you want to list all available model macros (which are macros capable of reading a model yaml file, asking you questions in a wizard-style and then update the model yaml file accordingly):
docker run --rm -it threagile/threagile list-model-macros

If you want to execute a certain model macro on the model yaml file (here the macro add-build-pipeline):
docker run --rm -it -v "$(pwd)":app/work threagile/threagile -model app/work/threagile.yaml -output app/work execute-model-macro add-build-pipeline
docker run --rm -it -v "$(pwd)":app/work threagile/threagile --model app/work/threagile.yaml --output app/work execute-model-macro add-build-pipeline

Usage:
threagile [flags]
Expand Down
12 changes: 6 additions & 6 deletions pkg/docs/constants.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ const (
"Version: " + ThreagileVersion + " (%v)"
Examples = "Examples:\n\n" +
"If you want to create an example model (via docker) as a starting point to learn about Threagile just run: \n" +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile " + common.CreateExampleModelCommand + " -output app/work \n\n" +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile " + common.CreateExampleModelCommand + " --output app/work \n\n" +
"If you want to create a minimal stub model (via docker) as a starting point for your own model just run: \n" +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile " + common.CreateStubModelCommand + " -output app/work \n\n" +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile " + common.CreateStubModelCommand + " --output app/work \n\n" +
"If you want to execute Threagile on a model yaml file (via docker): \n" +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile analyze-model -verbose -model -output app/work \n\n" +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile analyze-model --verbose --model --output app/work \n\n" +
"If you want to execute Threagile in interactive mode (via docker): \n" +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile -i -verbose -model -output app/work \n\n" +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile -i --verbose --model --output app/work \n\n" +
"If you want to run Threagile as a server (REST API) on some port (here 8080): \n" +
" docker run --rm -it --shm-size=256m -p 8080:8080 --name --mount 'type=volume,src=threagile-storage,dst=/data,readonly=false' threagile/threagile server --server-port 8080 \n\n" +
"If you want to find out about the different enum values usable in the model yaml file: \n" +
" docker run --rm -it threagile/threagile " + common.ListTypesCommand + "\n\n" +
"If you want to use some nice editing help (syntax validation, autocompletion, and live templates) in your favourite IDE: " +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile " + common.CreateEditingSupportCommand + " -output app/work\n\n" +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile " + common.CreateEditingSupportCommand + " --output app/work\n\n" +
"If you want to list all available model macros (which are macros capable of reading a model yaml file, asking you questions in a wizard-style and then update the model yaml file accordingly): \n" +
" docker run --rm -it threagile/threagile " + common.ListModelMacrosCommand + " \n\n" +
"If you want to execute a certain model macro on the model yaml file (here the macro add-build-pipeline): \n" +
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile -model app/work/threagile.yaml -output app/work execute-model-macro add-build-pipeline"
" docker run --rm -it -v \"$(pwd)\":app/work threagile/threagile --model app/work/threagile.yaml --output app/work execute-model-macro add-build-pipeline"
ThirdPartyLicenses = " - golang (Google Go License): https://golang.org/LICENSE\n" +
" - go-yaml (MIT License): https://github.com/go-yaml/yaml/blob/v3/LICENSE\n" +
" - graphviz (CPL License): https://graphviz.gitlab.io/license/\n" +
Expand Down

0 comments on commit 4db68f3

Please sign in to comment.