devy-ai v0.0.26

Devy

Devy is a shell-based AI assistant designed to alleviate the worry of remembering commands, to be proactive support with debugging, and to provide guidance on best practices for clean, efficient, and maintainable code.

Features

• Command Line Hero: Suggests and/or automatically executes commands for users. e.g "devy undo my last commit".
• Code Assistance: Identify and fix code errors, optimize code, and provide guidance on debugging tools.
• Proactive Help: Anticipate user needs and execute commands to help accomplish goals quicker.
• Multi-language Support: Generate code snippets in various programming languages.
• File Management: Read, create, update, and delete files as needed.
• System Control: Execute scripts and control system settings.

Getting Started

Devy requires NodeJs runtime, you can get that from here.

Then run:

npm install --foreground-scripts -g devy-ai

Devy also relies on the following models, which require an API key:

• Gemini - https://makersuite.google.com/app/apikey
• ChatGPT - https://platform.openai.com/account/api-keys
• Claude - https://console.anthropic.com/dashboard

Once you have obtained the keys, update the API key fields in ~/.devy/config.yaml.

For development

1. Clone the repository:

   git clone https://github.com/justiceo/devy.git

2. Navigate to the project directory:

   cd devy

3. Install dependencies:

   npm install

4. Run the tests:

   npm test

Verify Installation

1. First close all shells that were opened before Devy install
2. Open a new shell, this can be bash, zsh, or fish.
3. The text ✨ Devy is in here should be at the top. It only appears once, when a shell is created, it won't apear for subshells.

Usage

1. Invoke Devy directly

$ devy hello world

2. Run from source (ideal for development)

$ node <repo>/src/devy.js hello world

3. Pipe input to it (ideal for debugging the output of a command)

$ echo "hello world" | devy
# OR
$ npm run build | devy

4. Finally, remember that devy is in the shell, so you can forget the devy command too.

$ hello world