https://github.com/bcgov/gwa-cli
https://github.com/bcgov/gwa-cli
apis aps citz kong openapi
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bcgov/gwa-cli
- Owner: bcgov
- License: apache-2.0
- Created: 2020-08-21T23:45:26.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-20T17:38:36.000Z (12 months ago)
- Last Synced: 2025-04-23T19:25:06.736Z (9 months ago)
- Topics: apis, aps, citz, kong, openapi
- Language: Go
- Homepage:
- Size: 1.87 MB
- Stars: 6
- Watchers: 6
- Forks: 1
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GWA CLI
[](https://sonarcloud.io/dashboard?id=gwa-cli)
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
`gwa` is a tool for composing, validating and publishing Gateway configuration files to the BC Government's [API Services Portal](https://api.gov.bc.ca).
## Installation
To get started with `gwa`, follow the detailed instructions provided in the DevHub [installation](https://developer.gov.bc.ca/docs/default/component/aps-infra-platform-docs/how-to/gwa-install/) guide.
## Usage
### Use `--help`
To make the most out of the `gwa` tool, you can use the `--help` option to get detailed information on its various commands and options. Here's how you can use it:
1. **General Help**: To get an overview of all available commands, run:
```sh
gwa --help
```
This will list all the primary commands and provide a brief description of each.
2. **Command-Specific Help**: To get detailed information about a specific command, use `--help` with the command in question. For example, if you want to learn more about the `gateway` command, you can run:
```sh
gwa gateway --help
```
This will provide detailed information about the `gateway` command, including its syntax, options, and examples.
### Online documentation
Explore `gwa` commands in an easy-to-read reference format on the DevHub [CLI commands page](https://developer.gov.bc.ca/docs/default/component/aps-infra-platform-docs/reference/gwa-commands/).
The content on this page is the same as the `--help` output.
## Support
If you need support or have any questions about using `gwa`, you can reach out to our team in the following ways:
### Rocket.Chat
Rocket.Chat is a community platform where you can connect with our team and other users.
Create an account on [Rocket.Chat](https://docs.developer.gov.bc.ca/join-bc-rocket-chat/) and join the [#aps-ops](https://chat.developer.gov.bc.ca/channel/aps-ops) channel. In this channel, you can:
- Ask questions
- Share feedback
- Get real-time support
- Engage with other users who might have similar questions or use cases
### GitHub issue tracker
Alternatively, if you prefer asynchronous communication or need to report a bug, request a feature, or provide feedback, please use our GitHub [issue tracker](https://github.com/bcgov/gwa-cli/issues). On our GitHub issue tracker, you can:
- File new issues for bugs or feature requests
- Track the status of reported issues
- Contribute to discussions on existing issues
- View the roadmap and planned enhancements
By using either of these methods, our team will be able to assist you promptly and effectively. We are committed to ensuring you have a positive experience with `gwa` and are here to answer any questions you might have.
## Want to contribute?
See [CONTRIBUTING.md](https://github.com/bcgov/gwa-cli/blob/main/contribute.md) for more info on how to make contributions to this project.