Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/geektype/shelly
A GPT-4 powered shell assistant
https://github.com/geektype/shelly
ai assistant cli gpt gpt4 productivity rust shelly shelly-gpt tool
Last synced: 28 days ago
JSON representation
A GPT-4 powered shell assistant
- Host: GitHub
- URL: https://github.com/geektype/shelly
- Owner: geektype
- License: mit
- Created: 2024-01-07T16:24:44.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-03-27T15:19:22.000Z (9 months ago)
- Last Synced: 2024-04-17T21:59:26.337Z (8 months ago)
- Topics: ai, assistant, cli, gpt, gpt4, productivity, rust, shelly, shelly-gpt, tool
- Language: Rust
- Homepage:
- Size: 56.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Project state: **Under development**. Likely to contain undocumented bugs + security and safety vulnerabilities. Use at own risk.
# Shelly AI
#### A GPT-4 powered shell assistant
### Example usage
```
$ shelly "give me a list of all unique contributors to this repo and the number of commits they have made"
git shortlog -sne
```
## Installation
At the moment the only way to use shelly is by building from source. Eventually there will be more options available for installation.
### Build from source
#### Pre-requisites
To build this project you must have a functioning rust toolchain setup
* `rustc` >= 1.77
* `cargo` >= 1.77
#### Build
```shell
cargo build --release
```
#### Install
You simply need to place the compiled binary in a directory that exists on `PATH`. `/usr/local/bin` is normally considered a good place for programs you compile yourself.
```
cp ./target/release/shelly /usr/local/bin/shelly
```
Reload your shell and you should be able to run shelly
```
$ which shelly
/usr/local/bin/shelly
$ shelly --version
Shelly AI CLI assistant v0.1.0-alpha
```
*Optional:* If you want to use another keyword to invoke shelly instead of `shelly` you can create a symlink
```
sudo ln -s /usr/local/bin/shelly /usr/local/bin/ai
```
You can then invoke shelly using `ai` keyword