Skip to main content

A CLI coding super-framework using AI

Project description

Dravid (DRD) - AI-Powered CLI Coding Framework

Dravid (DRD) is an advanced, AI-powered CLI coding framework designed to streamline and enhance the development process. It leverages artificial intelligence to assist developers in various tasks, from project setup to code generation and file management.

Features

  • AI-powered CLI for efficient coding and project management
  • Image query handling capabilities
  • Robust file operations and metadata management
  • Integration with external APIs (Dravid API)
  • Built-in development server with file monitoring
  • Comprehensive error handling and reporting
  • Extensible architecture for easy feature additions

Installation

Prerequisites

  • Python 3.7+
  • pip (Python package installer)
  • CLAUDE_API_KEY (environment variable should be set)

To install Dravid, run the following command:

pip install dravid

Usage

After installation, you can use the drd command directly from your terminal. Here are some common usage examples:

NOTE: for better results, go step by step and communicate clearly. There is no RAG implementation, so there is a context window limit.

Basic Query

Execute a Dravid command:

drd "create a nextjs project"

The above command loads project context or project guidelines (you can create your own project_guidelines.txt) if they exist, along with any relevant file content in its context.

Ask Questions or Generate Content

Ask questions or generate content:

drd --ask "how is the weather"

Generate a file directly:

drd --ask "create a MIT LICENSE file, just the file, don't respond with anything else" >> LICENSE

--ask is much faster than the execute command because it doesn't load project context or project guidelines (you can create your own project_guidelines.txt)

Image-based Queries

Use image references in your queries:

drd "make the home image similar to the image" --image "~/Downloads/reference.png"

Development Server with Monitoring

Run the development server with automatic error fixing:

drd --monitor-init

Metadata Management

Initialize metadata for an existing project:

drd --meta-init

Update metadata after modifying files:

drd --meta-add "modified the about page"

File-specific Queries

Ask for suggestions on specific files:

drd --ask "can you suggest how to refactor this file" --file "src/main.py"

For more detailed usage instructions and options, use the help command:

drd --help

Project Structure

  • src/drd/: Main source code directory
    • cli/: Command-line interface modules
    • api/: API interaction and parsing modules
    • utils/: Utility functions and helpers
    • prompts/: AI prompt templates
    • metadata/: Project metadata management
  • tests/: Test suite for the project

Contributing

We welcome contributions to Dravid! Please see our Contributing Guide for more details on how to get started.

Development

To install Dravid, you need Python 3.7+ and Poetry. Follow these steps:

  1. Clone the repository:

    git clone https://github.com/vysakh0/dravid.git
    cd dravid
    
  2. Install dependencies using Poetry:

    poetry install
    
  3. Set up environment variables: Create a .env file in the project root and add your API keys:

    CLAUDE_API_KEY=your_claude_api_key_here
    
  4. You can use Dravid to add features or functionalities to the project. As this project uses drd.json and has used Dravid to build Dravid.

poetry run drd "refactor api_utils"

or

poetry run drd "add tests for utils/utils"
poetry run drd --ask "who are you"

Testing

After adding some functionalities, if you want to test how it works, I suggest creating a directory called myapp or testapp or test-app in the root of this project. These folder names are already in .gitignore.

cd myapp
poetry run drd "create a simple elixir project"

To run the test suite:

poetry run test

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Special thanks to the creators of the Claude AI model, which powers many of Dravid's capabilities

Contact

For questions, suggestions, or issues, please open an issue on the GitHub repository or contact the maintainers directly.

Happy coding with Dravid!

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

dravid-0.5.0.tar.gz (25.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dravid-0.5.0-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

Details for the file dravid-0.5.0.tar.gz.

File metadata

  • Download URL: dravid-0.5.0.tar.gz
  • Upload date:
  • Size: 25.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.6 Darwin/23.5.0

File hashes

Hashes for dravid-0.5.0.tar.gz
Algorithm Hash digest
SHA256 d1883725375acd724c3c88b2ef28aeafb800f8f0abbdac2e17bb9257065ec25c
MD5 10721f4516b59ef90b052f7f29f52678
BLAKE2b-256 bad2ccf9685aeb6c2fb5fb3e3371bc2f42b4e16eeaec3b3b90176122cafe44c7

See more details on using hashes here.

File details

Details for the file dravid-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: dravid-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 35.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.6 Darwin/23.5.0

File hashes

Hashes for dravid-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 382ac50a4152f527627bca6267947dc5f8bbab7b457d1baf912df74a4dc200d6
MD5 1496ff7275ffeb92e9290aa76931a805
BLAKE2b-256 5f6d3693934ddbdfa6e7fb27829c19158d72de08d86e588516c8aab29294f8ea

See more details on using hashes here.

Supported by

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