diff --git a/README.md b/README.md index ae2d29b..297f4d4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # cllm [![Discord](https://dcbadge.vercel.app/api/server/sy9BhhdbJu?style=flat&compact=true)](https://discord.gg/sy9BhhdbJu) [![GitHub Release](https://img.shields.io/github/v/release/dev-backpack/cllm)](https://github.com/dev-backpack/cllm/releases) +[![CLLM Docs](https://img.shields.io/badge/Docs-CLLM-blue)](https://dev-backpack.github.io/cllm/) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) [![GitHub Issues](https://img.shields.io/github/issues/dev-backpack/cllm)](https://github.com/dev-backpack/cllm/issues) @@ -46,6 +47,19 @@ cllm set key [API_KEY] cllm search [QUERY] ``` +#### Show the history of commands searched + +```bash +cllm history +``` + +#### Show the description of a command + +```bash +cllm describe [COMMAND] +``` + + ## License ```cllm``` is licensed under the [MIT License](https://opensource.org/licenses/MIT). diff --git a/cllm-website/blog/2024-03-15-welcome/index.md b/cllm-website/blog/2024-03-15-welcome/index.md index 5017b36..6422d6b 100644 --- a/cllm-website/blog/2024-03-15-welcome/index.md +++ b/cllm-website/blog/2024-03-15-welcome/index.md @@ -14,7 +14,6 @@ Below are the list of commands that you can use to interact with CLLM. - `help` - To get the list of commands that you can use. - `search` - To search for a specific command about your query. - `set key` - To set the OpenAI API key for using CLLM. -- `history` - To get the history of (query, command) that you have used. If you have any questions or need help, feel free to ask in the [CLLM Discord](https://discord.gg/sy9BhhdbJu). diff --git a/cllm-website/blog/2024-03-25-CLLM-0.1.2/index.md b/cllm-website/blog/2024-03-25-CLLM-0.1.2/index.md new file mode 100644 index 0000000..706efb0 --- /dev/null +++ b/cllm-website/blog/2024-03-25-CLLM-0.1.2/index.md @@ -0,0 +1,29 @@ +--- +slug: release/0.1.2 +title: CLLM 0.1.2 +authors: [chanism] +tags: [release, cllm] +--- + +Today, we are excited to announce the release of CLLM 0.1.2! + +### Highlights + +This release includes the following updates: + +- Added the new `cllm history` command to show the history of commands searched. +- Added the new `cllm describe` command to show the description of a command. +- Added CLLM icon to documentation. + +### Other Changes +- [#29](https://github.com/dev-backpack/cllm/pull/29): Add installation script for macOS and Linux. +- [#34](https://github.com/dev-backpack/cllm/pull/34): Add error handling for CLI errors +- [#38](https://github.com/dev-backpack/cllm/pull/38): Add CLLM ASCII art logo to cllm + +For more details, please refer to the [release notes](https://github.com/dev-backpack/cllm/releases/tag/v0.1.2). + +![Release](./release-0.1.2-img.png) + +### Contact Us + +If you have any questions or need help, feel free to ask in the [CLLM Discord](https://discord.gg/sy9BhhdbJu). \ No newline at end of file diff --git a/cllm-website/blog/2024-03-25-CLLM-0.1.2/release-0.1.2-img.png b/cllm-website/blog/2024-03-25-CLLM-0.1.2/release-0.1.2-img.png new file mode 100644 index 0000000..ee84977 Binary files /dev/null and b/cllm-website/blog/2024-03-25-CLLM-0.1.2/release-0.1.2-img.png differ diff --git a/cllm-website/docs/commands/describe.md b/cllm-website/docs/commands/describe/index.mdx similarity index 100% rename from cllm-website/docs/commands/describe.md rename to cllm-website/docs/commands/describe/index.mdx diff --git a/cllm-website/docs/commands/history/img/cllm-history-2.gif b/cllm-website/docs/commands/history/img/cllm-history-2.gif new file mode 100644 index 0000000..6e68780 Binary files /dev/null and b/cllm-website/docs/commands/history/img/cllm-history-2.gif differ diff --git a/cllm-website/docs/commands/history/img/cllm-history.gif b/cllm-website/docs/commands/history/img/cllm-history.gif new file mode 100644 index 0000000..e0dc832 Binary files /dev/null and b/cllm-website/docs/commands/history/img/cllm-history.gif differ diff --git a/cllm-website/docs/commands/history.md b/cllm-website/docs/commands/history/index.mdx similarity index 86% rename from cllm-website/docs/commands/history.md rename to cllm-website/docs/commands/history/index.mdx index 6fcc566..b9254bd 100644 --- a/cllm-website/docs/commands/history.md +++ b/cllm-website/docs/commands/history/index.mdx @@ -17,9 +17,14 @@ cllm history -l -o -q ``` ## Options - +{/* table */} | Option | Default | Description | | --- | --- | -- | | `--limit` or `-l` | `10` | Limit the number of results to display. | | `--offset` or `-o` | `0` | Offset the results by a number. | -| `--query` or `-q` | `Optional` | Filter the results by a query. | \ No newline at end of file +| `--query` or `-q` | `Optional` | Filter the results by a query. | + +## Example + +{/* image */} +![history](./img/cllm-history-2.gif) \ No newline at end of file diff --git a/cllm-website/docs/commands/search.md b/cllm-website/docs/commands/search/index.mdx similarity index 73% rename from cllm-website/docs/commands/search.md rename to cllm-website/docs/commands/search/index.mdx index 1861bd6..ca7c84b 100644 --- a/cllm-website/docs/commands/search.md +++ b/cllm-website/docs/commands/search/index.mdx @@ -11,3 +11,7 @@ The `search` command is used to search for a command. ```bash cllm search ``` + +## Example + +![search](../../cllm-example-1.gif) diff --git a/cllm-website/static/img/cllm-social-card.png b/cllm-website/static/img/cllm-social-card.png index 871102a..b70a3a8 100644 Binary files a/cllm-website/static/img/cllm-social-card.png and b/cllm-website/static/img/cllm-social-card.png differ diff --git a/install.sh b/install.sh index 07fa1ef..3177f5c 100644 --- a/install.sh +++ b/install.sh @@ -19,14 +19,14 @@ OS=$(uname -s) case "$OS" in Linux*) # cllm download URL and file name for Linux - CLLM_URL="https://github.com/dev-backpack/cllm/releases/download/v0.1.1/cllm-x86_64-unknown-linux-gnu.tar.gz" + CLLM_URL="https://github.com/dev-backpack/cllm/releases/download/v0.1.2/cllm-x86_64-unknown-linux-gnu.tar.gz" # Install dependencies for cli-clipboard sudo apt install xorg-dev libxcb-composite0-dev ;; Darwin*) # cllm download URL and file name for macOS - CLLM_URL="https://github.com/dev-backpack/cllm/releases/download/v0.1.1/cllm-x86_64-apple-darwin.tar.gz" + CLLM_URL="https://github.com/dev-backpack/cllm/releases/download/v0.1.2/cllm-x86_64-apple-darwin.tar.gz" ;; *) echo "Unsupported operating system."