Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme, installation script, and docs to align with version 0.1.2 #45

Merged
merged 1 commit into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand Down Expand Up @@ -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).

Expand Down
1 change: 0 additions & 1 deletion cllm-website/blog/2024-03-15-welcome/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
29 changes: 29 additions & 0 deletions cllm-website/blog/2024-03-25-CLLM-0.1.2/index.md
Original file line number Diff line number Diff line change
@@ -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).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,14 @@ cllm history -l <limit> -o <offset> -q <query>
```

## Options
<!-- table -->
{/* 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. |
| `--query` or `-q` | `Optional` | Filter the results by a query. |

## Example

{/* image */}
![history](./img/cllm-history-2.gif)
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@ The `search` command is used to search for a command.
```bash
cllm search <command>
```

## Example

![search](../../cllm-example-1.gif)
Binary file modified cllm-website/static/img/cllm-social-card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
Loading