VaxFinder Admin CLI
A CLI for administrators to manage vaccine availabilities and other data for the Vaccine Hunters Finder tool.
Click here for installation instructions.
If you ever need help, run
vf-admin configure --key=<auth-key>
Before running all other commands, you must add an authentication key that can be obtained through one of the developers working on the VaxFinder backend. Multiple profiles are supported so you can be authenticated using multiple keys. To create a profile with an authentication key, run
vf-admin configure --key=<auth-key> --profile=<named-profile>.
Go to the
docs folder to view auto-generated documentation on the CLI.
Note that there is no stable release for this tool yet. ![construction](https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png =20x20)
go get .
Pre-commit hooks helps identify simple issues in code before it's committed into Git.
Follow installation instructions for pre-commit here.
Install the git hook scripts
Temporarily Disabling hooks
It's possible to disable hooks temporarily, but it isn't recommended.
$ SKIP=go-fmt,go-vet,go-lint git commit -m <message>
go run main.go help
You can also install the application locally which is how it is expected to be used in production. In order to do this, you must first set
GOBIN appropriately. If they are not set, add this to your
.bash_profile etc. AND open new terminal.
make install vf-admin help
Generating an OpenAPI Client
After running this command, you may find that there is an issue. This is discussed here. In the meantime, manually fix the issue on line ~28 at
internal/api/client.gen.go by replacing
InputTypeEnum InputTypeEnum = 1 with
InputTypeEnum0 InputTypeEnum = 1.
Generating Docs Automatically
How to install
How to uninstall