diff --git a/assets/img/gh-chat.png b/assets/img/gh-chat.png new file mode 100644 index 0000000..9d7fcc6 Binary files /dev/null and b/assets/img/gh-chat.png differ diff --git a/assets/img/gh-chat.svg b/assets/img/gh-chat.svg new file mode 100644 index 0000000..b8c34fc --- /dev/null +++ b/assets/img/gh-chat.svg @@ -0,0 +1,4 @@ + + + + diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..11d8499 --- /dev/null +++ b/readme.md @@ -0,0 +1,36 @@ +# ![](https://github.com/devlooped/gh-chat/raw/main/assets/img/gh-chat.png) GitHub CLI Chat Extension + +An extension to interact with the [GitHub CLI](https://cli.github.com/) using +natural language. + +## Installation + +The [GitHub CLI](https://cli.github.com/) must be installed first. + +Install: + +```shell +gh extension install devlooped/gh-chat +``` + +Upgrade: + +```shell +gh extension upgrade chat +``` + +Uninstall: + +```shell +gh extension remove chat +``` + +The extension uses the [GitHub CLI API](https://cli.github.com/manual/gh_api) to +run queries and render them to the console. + + +## Usage + +The extension adds a `chat` command to the `gh` CLI, which you can use to +interact with the GitHub API using natural language. +