harmonichemispheres / pencil

pencil is a simple ai based multifile project writer.

✏️ Pencil is a simple AI-based multi-file project writer. ✏️

Pencil

Pencil is a simple AI-based multi-file project writer. It leverages OpenAI's models to assist in generating, maintaining, and updating code across multiple files in a project.

Table of Contents

• Quick Start
• Installation
• Usage
• CLI Commands
• Contributing

Quick Start

To get started with Pencil, you can follow the instructions provided below for installation and usage.

Installation

NOTE: This package works with Python >= 3.12

Install from Github

git clone https://github.com/GoInterject/pencil.git
cd pencil
python -m pip install .

Install from Python Package Index (⚠️ coming soon ⚠️)

pip install pencilai

Usage

To interactively chat with the AI-based project writer:

pencil chat --openai-api-key "<YOUR_OPENAI_API_KEY>"

Replace <YOUR_OPENAI_API_KEY> with your actual OpenAI API key.

CLI Commands

To list all the files in the project directory:

pencil ls --base-dir "/path/to/project"

You can replace /path/to/project with the path to your project directory. Default is the current directory (.).

Contributing

We welcome contributions to Pencil! To do so, please follow these steps:

1. Fork the repository from GitHub.
2. Clone your forked repository:

   git clone https://github.com/YOUR_USERNAME/pencil.git
   

3. Create a new branch for your feature or bugfix:

   git checkout -b feature-or-bugfix-name
   

4. Make the necessary changes and commit them:

   git commit -m "Description of your changes"
   

5. Push your changes to your forked repository:

   git push origin feature-or-bugfix-name
   

6. Open a pull request on the original repository and provide a brief description of your changes.

We will review your pull request as soon as possible. Thank you for contributing!

License

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