Skip to content

Commit 3301453

Browse files
nroulongithub-actions[bot]
authored andcommitted
📝 Update CLI configuration documentation
1 parent 3fc833a commit 3301453

1 file changed

Lines changed: 3 additions & 5 deletions

File tree

docs/cli-configuration.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# Options
22
|Names|Default value|Needs argument|Possible arguments|Description|Examples|
33
|---|---|---|---|---|---|
4-
|--version, --v, -v, -version|No default value||N/A|Show the version and exit||
4+
|--version, --V, -V, -version|No default value||N/A|Show the version and exit||
55
|--working-directory-path, --wd|No default value|| |path to the working directory. Can be relative but prefer absolute path. All relative paths configured will be relative to this path if set.||
66
|--config-file-path|No default value|| |Path to config file. File must exist.|```myProject/src/main/resources/config/datamaintain.properties```|
77
|--db-type|mongo||```mongo``` or ```jdbc```|db type||
88
|--db-uri|No default value||TEXT|mongo uri with at least database name. Ex: mongodb://localhost:27017/newName|```mongodb://localhost:27017/newName```|
99
|--trust-uri|false||N/A|Deactivate all controls on the URI you provide Datamaintain||
1010
|--mongo-tmp-path|/tmp/datamaintain.tmp||TEXT|mongo tmp file path||
11+
|--verbose, -v|false||N/A|verbose||
12+
|-vv|false||N/A|trace is more verbose than verbose||
1113
|--config|No default value||N/A|Print the configuration without executing the subcommand||
1214
|-h, --help|No default value||N/A|Display command help and exit||
1315
# Subcommands
@@ -25,8 +27,6 @@
2527
|--execution-mode|NORMAL||```NORMAL``` or ```DRY```|execution mode||
2628
|--action|RUN||```RUN``` or ```MARK_AS_EXECUTED``` or ```OVERRIDE_EXECUTED```|script action||
2729
|--allow-auto-override|false||N/A|Allow datamaintain to automaticaly override scripts||
28-
|--verbose, -v|false||N/A|verbose||
29-
|-vv|false||N/A|trace is more verbose than verbose||
3030
|--save-db-output|false||N/A|save your script and db output||
3131
|--print-db-output|false||N/A|print your script and db output||
3232
|--tag|No default value|| |Tag defined using glob path matchers. To define multiple tags, use option multiple times. Syntax example: MYTAG1=[pathMatcher1, pathMatcher2]|```MYTAG1=[pathMatcher1, pathMatcher2]```|
@@ -47,6 +47,4 @@
4747
|Names|Default value|Needs argument|Possible arguments|Description|Examples|
4848
|---|---|---|---|---|---|
4949
|--path|./scripts/||TEXT|path to the script you want to mark as executed|```scripts/myScript1.js```|
50-
|--verbose, -v|false||N/A|verbose||
51-
|-vv|false||N/A|trace is more verbose than verbose||
5250
|-h, --help|No default value||N/A|Display command help and exit||

0 commit comments

Comments
 (0)