Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Andriiklymiuk
Andriiklymiuk committed Oct 17, 2022
1 parent d7280a6 commit 72db046
Show file tree
Hide file tree
Showing 6 changed files with 128 additions and 40 deletions.
10 changes: 6 additions & 4 deletions cmd/root.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`,
Expand All @@ -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.
`,
Expand Down
34 changes: 25 additions & 9 deletions resources/readme/corgi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
28 changes: 22 additions & 6 deletions resources/readme/corgi_clean.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
28 changes: 22 additions & 6 deletions resources/readme/corgi_db.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
28 changes: 22 additions & 6 deletions resources/readme/corgi_init.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
40 changes: 31 additions & 9 deletions resources/readme/corgi_run.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 72db046

Please sign in to comment.