Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ricopinazo authored May 8, 2024
1 parent 5263355 commit 5c1a060
Showing 1 changed file with 8 additions and 16 deletions.
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,23 @@

## What is comai? 🎯

`comai` is an open source terminal assistant powered by OpenAI API that enables you to interact with your command line interface using natural language instructions. It simplifies your workflow by converting natural language queries into executable commands. No more memorizing complex syntax. Just chat with `comai` using plain English!
`comai` is an open source CLI utility that translates natural language instructions into executable commands.

<div align="left">
<img src="https://raw.githubusercontent.com/ricopinazo/comai/main/demo.gif" alt="demo" width="350"/>
</div>

## Installation 🚀

Getting `comai` up and running is a breeze. You just need to install the python package. We recommend using [`pipx`](https://pypa.github.io/pipx/):
`comai` is available python package. We recommend using [`pipx`](https://pypa.github.io/pipx/):

```shell
pipx install comai
```

By default, `comai` is setup to use [ollama](https://ollama.com) under the hood, which allows you to host any popular open source LLM locally. If you are happy with this, make sure to install and have ollama running. You can find the install instructions [here](https://ollama.com/download).

Once it is installed, make sure to download the `llama3` model, since comai has been optimised for it
Once installed, make sure to download the `llama3` model, since comai has been optimised for it

```shell
ollama pull llama3
Expand All @@ -56,7 +56,7 @@ Using `comai` is straightforward. Simply invoke the `comai` command followed by
Let's dive into some exciting examples of how you can harness the power of `comai`:
1. Manage your system like a pro:
1. Access network details:
```shell
$ comai print my private ip address
Expand All @@ -68,7 +68,7 @@ $ comai and my public one
92.234.58.146
```
2. Master the intricacies of `git`:
2. Manage `git` like a pro:
```shell
$ comai squash the last 3 commits into a single commit
Expand Down Expand Up @@ -104,29 +104,21 @@ $ comai kill it
❯ kill $(lsof -t -i :8080)
```
5. Swiftly get rid of all your docker containers:
5. Get rid of all your docker containers:
```shell
$ comai stop and remove all running docker containers
❯ docker stop $(docker ps -aq) && docker rm $(docker ps -aq)
```
These are just a few examples of how `comai` can help you harness the power of the command line and provide you with useful and entertaining commands. Feel free to explore and experiment with the commands generated by `comai` to discover more exciting possibilities!
## Contributions welcome! 🤝
If you're interested in joining the development of new features for `comai`, here's all you need to get started:
1. Clone the [repository](https://github.com/ricopinazo/comai) and navigate to the root folder.
2. Install the package in editable mode by running `pip install -e .`.
3. Run the tests using `pytest`. Make sure you have the `OPENAI_API_KEY` environment variable set up with your OpenAI API key. Alternatively, you can create a file named `.env` and define the variable there.
This project utilizes black for code formatting. To ensure your changes adhere to this format, simply follow these steps:
```shell
pip install black
black .
```
3. Run the tests using `pytest`.
4. Format your code using [black](https://github.com/psf/black) before submitting any change.
## License 📜
Expand Down

0 comments on commit 5c1a060

Please sign in to comment.