Skip to main content

CLARA: Code Language Assistant & Repository Analyzer

Project description

CLARA: Code Language Assistant & Repository Analyzer 📜🔍🤖

Python 3.10 Code style: black

Clara is a tool to help developers understand and work with a code repository.

Features

This project is currently in its early stages of development and is considered a work in progress. You may encounter some issues, or incomplete features. We appreciate your understanding and patience as we continue to refine and enhance the project. Your feedback will help us improve and shape this project.

Introduction

Clara is an AI-powered tool designed to assist developers in navigating unfamiliar code repositories, making it highly valuable during the on-boarding process for new projects, or when deciphering legacy code..

In the future, Clara will also provide support for tasks such as documentation, auditing, and developing new features, among others.

Usage

Install:

pipx install clara-ai

Or:

pip3 install clara-ai

Usage

Firstly, set an environment variable with your OpenAI API key:

export OPENAI_API_KEY="XXXXXX"

Then, use the command:

$ clara chat [PATH]

If the path is omitted, '.' will be used.

To exit use CTRL-C or CTRL-D.

All commands:

COMMANDS
    COMMAND is one of the following:

     chat
       Chat about the code.

     clean
       Delete vector DB for a given path.

     config
       Get config for a given path.

Roadmap

[ ] Improve chat: short-term history, context, personality,... [ ] Tools: document code, audit, refactoring, test creation,...

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clara_ai-0.0.2.tar.gz (5.2 kB view hashes)

Uploaded Source

Built Distribution

clara_ai-0.0.2-py3-none-any.whl (6.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page