manai

KO | EN

gitlite — search

#javascript #python #hacktoberfest #llm #golang #android #rust #linux #docker #nodejs #awesome #kubernetes #vue #security

(★ 29)

AI powered interactive command line completion for Zsh

manai Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

manai
=====
<div align="center">
    <img src="doc/img/logo.svg" width="480">
</div>

manai is an AI powered interactive command line completion for Zsh. Hotkey to trigger and ask anything about your work-in-progress command line.

![demo](https://raw.githubusercontent.com/mecab/manai/master/doc/img/demo.gif)

Prerequisites
-------------
- [Zsh](https://www.zsh.org/)
- [fzf](https://github.com/junegunn/fzf)
- [OpenAI API Key](https://platform.openai.com)

Installation
------------

1. Clone this package to somewhere you are comfortable with (e.g. `$HOME/.dotfiles/manai`)

```bash
    $ git clone git@github.com:mecab/manai.git $HOME/.dotfiles/manai
    ```

2. Download manai binary (why?/you don't trust the binary? see [Build Manai Binary by Yourself](#build-manai-binary-by-yourself))

```bash
    $ $HOME/.dotfiles/manai/download-manai.zsh
    ```

3. Source `manai.zsh` in your zshrc, set your `OPENAI_API_KEY` then bind `manai` function to any keybind

```bash
    $ nano ~/.zshrc
    ```

and add the following

```
    export OPENAI_API_KEY="your-openai-api-key"
    source $HOME/.dotfiles/manai/manai.zsh

# bind to `Alt-h`. Update this to your preference!
    bindkey '\eh' manai
    ```

Note: You can also specify `MANAI_OPENAI_API_KEY` instead of `OPENAI_AI_KEY` for `manai` exclusive use.

4. then reload your zshrc

```bash
    $ exec $SHELL -l
    ```

Build Manai Binary by Yourself
------------------------------

Manai uses a binary executable to process the output from ChatGPT because it is difficult to handle the streamed output using only shell scripts. For convenience, pre-built binaries are distributed, but you can also build it yourself. It is written in TypeScript and can be compiled if you have Bun installed.

1. Install JS Dependencies
    
    ```bash
    $ cd $HOME/.dotfiles/manai
    $ bun install
    ```

2. Build the binary

```bash
    $ bun run build
    ```

It should generate `bin/manai` binary for your architecture.

Why "Manai"?
-------------
- man + AI
- (悩)まない (naya)manai - "worry-free" in Japanese

manai

manai Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

manai

manai Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README