Simple CLI to wrap the graphql api #40
Closed
Conversation
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 commit adds a golang-based command line interface that may wrap the graphql api. Only a very basic cli is added, offering only help and version commands, but other commands can be easily added. The source for zbctl is the origin of this source code. I've stripped its commands, altered some wording and that's it. Example usage: ``` zeeqs help ``` zeeqs is command line interface designed to query the Zeebe Query Service for aggregated Zeebe data. Usage: zeeqs [command] Available Commands: help Help about any command version Print the version of zeeqs Flags: -h, --help help for zeeqs Use "zeeqs [command] --help" for more information about a command.
This commit adds a PoC to actually query the graphql api by adding a
workflows command.
It simply executes the equivalent of:
```
curl \
-X POST \
-H "Content-Type: application/json" \
--data '{ "query": "{ workflows { nodes { key } } }" }' \
http://localhost:9000/graphql
```
|
Great idea 👍 |
|
|
|
Oops, I clicked the wrong button 😅 @korthout are you still interested in developing the CLI? |
|
Currently, I don't intend to continue working on it. Perhaps in the future this becomes more interesting again. We can archive (close) it for now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
adds a golang-based command line interface that may wrap the
graphql api. Only a very basic cli is added, offering only help, version
and workflows commands, but other commands can be easily added.
The source for zbctl is the origin of this source code. I've stripped
its commands, altered some wording and that's it.
Proposal
This PR is a proposal and offers the core of a golang-based CLI. It is in
no way a comprehensive interface at this time. We should discuss
whether this solution fits with the graphql concepts.
For example, we should discuss the maintenance cost of adding new
graphql types and fields considering they would now also require
manual implementation in this cli.
Example usage:
zeeqs helpzeeqs versionzeeqs workflows