-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Auto generated CLI docs in
docs/0.0.0
.
- Loading branch information
github-actions
committed
May 21, 2021
1 parent
1576418
commit 5e3bf19
Showing
23 changed files
with
694 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
## vf-admin location | ||
|
||
Manage locations | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for location | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin](vf-admin.md) - vf-admin is a CLI to manage vaccine availabilities and other data for the Vaccine Hunters Finder tool. | ||
* [vf-admin location add](vf-admin_location_add.md) - Add a new location | ||
* [vf-admin location get](vf-admin_location_get.md) - Retrieve a location with a specified id | ||
* [vf-admin location list](vf-admin_location_list.md) - Retrieve a list of locations | ||
* [vf-admin location remove](vf-admin_location_remove.md) - Remove a location with a specified id | ||
* [vf-admin location update](vf-admin_location_update.md) - Update a location with a specified id | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
## vf-admin location add | ||
|
||
Add a new location | ||
|
||
``` | ||
vf-admin location add [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Add a new active location with name "Guelph Hospital", postal code "N1E 4J4", website URL "http://www.gghorg.ca/", phone "(519) 822-5350", notes "Please call ahead to make an appointment.", tags "Guelph, Appointment", organization id 23 and address id 352. | ||
$ vf-admin location add --active 1 --name "Guelph Hospital" --postcode "N1E4J4" --url "http://www.gghorg.ca" --phone "(519) 822-5350" --notes "Please call ahead to make an appointment." --tags "Guelph, Appointment" --organization 23 --address 352 | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--active int is this location active? 1 or 0 (default 1) | ||
--address int id of address of location | ||
-h, --help help for add | ||
--name string name of location | ||
--notes string notes about location | ||
--organization int id of organization running location | ||
--phone string phone number of location | ||
--postcode string postal code of location | ||
--tags string search tags of location | ||
--url string website URL of location | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin location](vf-admin_location.md) - Manage locations | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
## vf-admin location get | ||
|
||
Retrieve a location with a specified id | ||
|
||
``` | ||
vf-admin location get [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Get the location with id 1. | ||
$ vf-admin location get 1 | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for get | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin location](vf-admin_location.md) - Manage locations | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
## vf-admin location list | ||
|
||
Retrieve a list of locations | ||
|
||
``` | ||
vf-admin location list [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for list | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin location](vf-admin_location.md) - Manage locations | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
## vf-admin location remove | ||
|
||
Remove a location with a specified id | ||
|
||
``` | ||
vf-admin location remove [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Remove the location with id 8. | ||
$ vf-admin location remove 8 | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for remove | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin location](vf-admin_location.md) - Manage locations | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
## vf-admin location update | ||
|
||
Update a location with a specified id | ||
|
||
``` | ||
vf-admin location update [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Update the location with id 15 to be active, have name "Guelph Hospital", postal code "N1E 4J4", website URL "http://www.gghorg.ca/", phone "(519) 822-5350", notes "Please call ahead to make an appointment.", tags "Guelph, Appointment", organization id 23 and address id 352. | ||
$ vf-admin location update 15 --active 1 --name "Guelph Hospital" --postcode "N1E4J4" --url "http://www.gghorg.ca" --phone "(519) 822-5350" --notes "Please call ahead to make an appointment." --tags "Guelph, Appointment" --organization 23 --address 352 | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--active int is this location active? 1 or 0 (default 1) | ||
--address int id of address of location | ||
-h, --help help for update | ||
--name string name of location | ||
--notes string notes about location | ||
--organization int id of organization running location | ||
--phone string phone number of location | ||
--postcode string postal code of location | ||
--tags string search tags of location | ||
--url string website URL of location | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin location](vf-admin_location.md) - Manage locations | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
## vf-admin va | ||
|
||
Manage vaccine availabilities | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for va | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin](vf-admin.md) - vf-admin is a CLI to manage vaccine availabilities and other data for the Vaccine Hunters Finder tool. | ||
* [vf-admin va add](vf-admin_va_add.md) - Add a new vaccine availability | ||
* [vf-admin va get](vf-admin_va_get.md) - Retrieve a vaccine availability with a specified id | ||
* [vf-admin va list](vf-admin_va_list.md) - Retrieve a list of vaccine availabilities within the vicinity of a postal code | ||
* [vf-admin va remove](vf-admin_va_remove.md) - Remove a vaccine availability with a specified id | ||
* [vf-admin va requirement](vf-admin_va_requirement.md) - Manage requirements for vaccine availability | ||
* [vf-admin va timeslot](vf-admin_va_timeslot.md) - Manage timeslots for vaccine availability | ||
* [vf-admin va update](vf-admin_va_update.md) - Update a vaccine availability with a specified id | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
## vf-admin va add | ||
|
||
Add a new vaccine availability | ||
|
||
``` | ||
vf-admin va add [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Add new vaccine availability on 2021-05-25 with 3 available input type 1 location 1651 and tags vhc | ||
$ vf-admin va add --date "2021-05-25" --numberavailable 3 --inputtype 1 --location 1651 --tags vhc | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--date string date for availability (YYYY-MM-DD) | ||
-h, --help help for add | ||
--inputtype int input type | ||
--location int id of the location | ||
--numberavailable int number of vaccines available | ||
--numbertotal int total number of vaccines | ||
--tags string tags | ||
--vaccine int id of the vaccine | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
## vf-admin va get | ||
|
||
Retrieve a vaccine availability with a specified id | ||
|
||
``` | ||
vf-admin va get [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Get the vaccine availability with id 014cc133-484f-4320-be3b-444e758b64a7 | ||
$ vf-admin va get 014cc133-484f-4320-be3b-444e758b64a7 | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for get | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
## vf-admin va list | ||
|
||
Retrieve a list of vaccine availabilities within the vicinity of a postal code | ||
|
||
``` | ||
vf-admin va list [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# List the vaccine availabilities within the vicinity of a postal code. | ||
$ vf-admin va list --postcode K1A | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for list | ||
--mindate string minimum date for availability (YYYY-MM-DD) | ||
--postcode string postal code to search around | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
## vf-admin va remove | ||
|
||
Remove a vaccine availability with a specified id | ||
|
||
``` | ||
vf-admin va remove [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Remove vaccine availability id 7d7488e4-cc26-434d-85c4-b7df2f7e3171 | ||
$ vf-admin va remove 7d7488e4-cc26-434d-85c4-b7df2f7e3171 | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for remove | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
--profile string specifies the named profile to use for this command (default "default") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [vf-admin va](vf-admin_va.md) - Manage vaccine availabilities | ||
|
Oops, something went wrong.