From 72db046168643b9a2c8c375996309a08a0e0e476 Mon Sep 17 00:00:00 2001 From: Andrii Klymiuk Date: Mon, 17 Oct 2022 20:07:43 +0300 Subject: [PATCH] Updated docs --- cmd/root.go | 10 +++++---- resources/readme/corgi.md | 34 ++++++++++++++++++++-------- resources/readme/corgi_clean.md | 28 ++++++++++++++++++----- resources/readme/corgi_db.md | 28 ++++++++++++++++++----- resources/readme/corgi_init.md | 28 ++++++++++++++++++----- resources/readme/corgi_run.md | 40 +++++++++++++++++++++++++-------- 6 files changed, 128 insertions(+), 40 deletions(-) diff --git a/cmd/root.go b/cmd/root.go index b8e008e..48c3f1b 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -76,10 +76,11 @@ func init() { "services", "", []string{}, - `Slice of services to start. + `Slice of services to choose from. -If you provide at least 1 services here, than corgi will run only this service, while ignoring all others. +If you provide at least 1 services here, than corgi will choose only this service, while ignoring all others. none - will ignore all services run. +(--services app,server) By default all services are included and run. `, @@ -89,10 +90,11 @@ By default all services are included and run. "dbServices", "", []string{}, - `Slice of db_services to start. + `Slice of db_services to choose from. -If you provide at least 1 db_service here, than corgi will run only this db, while ignoring all others. +If you provide at least 1 db_service here, than corgi will choose only this db_service, while ignoring all others. none - will ignore all db_services run. +(--dbServices db,db1,db2) By default all db_services are included and run. `, diff --git a/resources/readme/corgi.md b/resources/readme/corgi.md index fa396ec..9344f25 100644 --- a/resources/readme/corgi.md +++ b/resources/readme/corgi.md @@ -24,14 +24,30 @@ corgi run ### Options ``` - --describe Describe contents of corgi-compose file - --doc Generate cobra docs - -f, --filename string Custom filepath for for corgi-compose - --fromScratch Clean corgi_services folder before running - -h, --help help for corgi - --silent Hide all welcome messages - -t, --toggle Help message for toggle - -v, --version version for corgi + --dbServices strings Slice of db_services to choose from. + + If you provide at least 1 db_service here, than corgi will choose only this db_service, while ignoring all others. + none - will ignore all db_services run. + (--dbServices db,db1,db2) + + By default all db_services are included and run. + + --describe Describe contents of corgi-compose file + --doc Generate cobra docs + -f, --filename string Custom filepath for for corgi-compose + --fromScratch Clean corgi_services folder before running + -h, --help help for corgi + --services strings Slice of services to choose from. + + If you provide at least 1 services here, than corgi will choose only this service, while ignoring all others. + none - will ignore all services run. + (--services app,server) + + By default all services are included and run. + + --silent Hide all welcome messages + -t, --toggle Help message for toggle + -v, --version version for corgi ``` ### SEE ALSO @@ -41,4 +57,4 @@ corgi run * [corgi init](corgi_init.md) - Create db service * [corgi run](corgi_run.md) - Run all databases and services -###### Auto generated by spf13/cobra on 13-Oct-2022 +###### Auto generated by spf13/cobra on 17-Oct-2022 diff --git a/resources/readme/corgi_clean.md b/resources/readme/corgi_clean.md index 90a923b..b528eb0 100644 --- a/resources/readme/corgi_clean.md +++ b/resources/readme/corgi_clean.md @@ -42,15 +42,31 @@ corgi clean -i db ### Options inherited from parent commands ``` - --describe Describe contents of corgi-compose file - --doc Generate cobra docs - -f, --filename string Custom filepath for for corgi-compose - --fromScratch Clean corgi_services folder before running - --silent Hide all welcome messages + --dbServices strings Slice of db_services to choose from. + + If you provide at least 1 db_service here, than corgi will choose only this db_service, while ignoring all others. + none - will ignore all db_services run. + (--dbServices db,db1,db2) + + By default all db_services are included and run. + + --describe Describe contents of corgi-compose file + --doc Generate cobra docs + -f, --filename string Custom filepath for for corgi-compose + --fromScratch Clean corgi_services folder before running + --services strings Slice of services to choose from. + + If you provide at least 1 services here, than corgi will choose only this service, while ignoring all others. + none - will ignore all services run. + (--services app,server) + + By default all services are included and run. + + --silent Hide all welcome messages ``` ### SEE ALSO * [corgi](corgi.md) - Corgi cli magic friend -###### Auto generated by spf13/cobra on 13-Oct-2022 +###### Auto generated by spf13/cobra on 17-Oct-2022 diff --git a/resources/readme/corgi_db.md b/resources/readme/corgi_db.md index 6d06eda..bcca930 100644 --- a/resources/readme/corgi_db.md +++ b/resources/readme/corgi_db.md @@ -28,15 +28,31 @@ corgi db [flags] ### Options inherited from parent commands ``` - --describe Describe contents of corgi-compose file - --doc Generate cobra docs - -f, --filename string Custom filepath for for corgi-compose - --fromScratch Clean corgi_services folder before running - --silent Hide all welcome messages + --dbServices strings Slice of db_services to choose from. + + If you provide at least 1 db_service here, than corgi will choose only this db_service, while ignoring all others. + none - will ignore all db_services run. + (--dbServices db,db1,db2) + + By default all db_services are included and run. + + --describe Describe contents of corgi-compose file + --doc Generate cobra docs + -f, --filename string Custom filepath for for corgi-compose + --fromScratch Clean corgi_services folder before running + --services strings Slice of services to choose from. + + If you provide at least 1 services here, than corgi will choose only this service, while ignoring all others. + none - will ignore all services run. + (--services app,server) + + By default all services are included and run. + + --silent Hide all welcome messages ``` ### SEE ALSO * [corgi](corgi.md) - Corgi cli magic friend -###### Auto generated by spf13/cobra on 13-Oct-2022 +###### Auto generated by spf13/cobra on 17-Oct-2022 diff --git a/resources/readme/corgi_init.md b/resources/readme/corgi_init.md index 4eeaed4..e68a099 100644 --- a/resources/readme/corgi_init.md +++ b/resources/readme/corgi_init.md @@ -22,15 +22,31 @@ corgi init [flags] ### Options inherited from parent commands ``` - --describe Describe contents of corgi-compose file - --doc Generate cobra docs - -f, --filename string Custom filepath for for corgi-compose - --fromScratch Clean corgi_services folder before running - --silent Hide all welcome messages + --dbServices strings Slice of db_services to choose from. + + If you provide at least 1 db_service here, than corgi will choose only this db_service, while ignoring all others. + none - will ignore all db_services run. + (--dbServices db,db1,db2) + + By default all db_services are included and run. + + --describe Describe contents of corgi-compose file + --doc Generate cobra docs + -f, --filename string Custom filepath for for corgi-compose + --fromScratch Clean corgi_services folder before running + --services strings Slice of services to choose from. + + If you provide at least 1 services here, than corgi will choose only this service, while ignoring all others. + none - will ignore all services run. + (--services app,server) + + By default all services are included and run. + + --silent Hide all welcome messages ``` ### SEE ALSO * [corgi](corgi.md) - Corgi cli magic friend -###### Auto generated by spf13/cobra on 13-Oct-2022 +###### Auto generated by spf13/cobra on 17-Oct-2022 diff --git a/resources/readme/corgi_run.md b/resources/readme/corgi_run.md index 8044091..e651b8a 100644 --- a/resources/readme/corgi_run.md +++ b/resources/readme/corgi_run.md @@ -13,23 +13,45 @@ corgi run [flags] ### Options ``` - -h, --help help for run - --omitBeforeStart Omits all before start commands from corgi-compose config - -s, --seed Seed all db_services that have seedSource or have dump.sql in their folder + -h, --help help for run + --omit strings Slice of parts of service to omit. + + beforeStart - beforeStart in services is omitted. + afterStart - afterStart in services is omitted. + + By default nothing is omitted + + -s, --seed Seed all db_services that have seedSource or have dump.sql in their folder ``` ### Options inherited from parent commands ``` - --describe Describe contents of corgi-compose file - --doc Generate cobra docs - -f, --filename string Custom filepath for for corgi-compose - --fromScratch Clean corgi_services folder before running - --silent Hide all welcome messages + --dbServices strings Slice of db_services to choose from. + + If you provide at least 1 db_service here, than corgi will choose only this db_service, while ignoring all others. + none - will ignore all db_services run. + (--dbServices db,db1,db2) + + By default all db_services are included and run. + + --describe Describe contents of corgi-compose file + --doc Generate cobra docs + -f, --filename string Custom filepath for for corgi-compose + --fromScratch Clean corgi_services folder before running + --services strings Slice of services to choose from. + + If you provide at least 1 services here, than corgi will choose only this service, while ignoring all others. + none - will ignore all services run. + (--services app,server) + + By default all services are included and run. + + --silent Hide all welcome messages ``` ### SEE ALSO * [corgi](corgi.md) - Corgi cli magic friend -###### Auto generated by spf13/cobra on 13-Oct-2022 +###### Auto generated by spf13/cobra on 17-Oct-2022