AI-powered tool for creating, analyzing, and modifying files using natural language
Project description
Filepilot 🚀✨
Filepilot is an AI-powered tool for creating, analyzing, and modifying files using Natural Language Processing (NLP). It provides a command-line interface (CLI) for interacting with Anthropic's Claude AI assistant using the Claude-3-5-Sonnet model, leveraging its capabilities to generate file content, analyze existing files, and apply edits based on natural language instructions.
Demo
Features ✨
- 🆕 Create: Generate new files with AI-generated content based on a description and optional reference files
- 🔍 Analyze: Get a concise summary of a file's main purpose using NLP
- 🚀 Modify: Edit existing files by providing natural language instructions, with syntax-highlighted visual diffs for reviewing changes
- 🤖 Powered by Claude-3: Harness the power of Anthropic's Claude-3-5-Sonnet model to streamline file operations
Installation 🛠️
You can install Filepilot using pip:
pip install filepilot
Or install from source:
- Clone the repository:
git clone https://github.com/joaompinto/filepilot.git
cd filepilot
- Install the required dependencies:
pip install -r requirements.txt
- Set up your Anthropic API key:
export ANTHROPIC_API_KEY="your-api-key-here"
Usage 📖
The package provides a command-line interface:
filepilot --help
This will display the available commands and options. Here are a few examples:
# Create a new file
filepilot create README.md "Generate a README file for the Filepilot project"
# Analyze an existing file
filepilot analyze filepilot.py
# Modify an existing file
filepilot change filepilot.py "Add a new feature to handle CSV files"
# Update an existing file from analyzing reference files
filepilot update requirements.txt app.py
For detailed diffs and verbose output, you can enable verbose mode:
export VERBOSE_MODE=true
Contributing 🤝
Contributions are welcome! Please follow the contributing guidelines for more information.
License 📄
This project is licensed under the MIT License.
For Docker installation and usage instructions, see the Docker Guide.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file filepilot-0.2.0-py3-none-any.whl
.
File metadata
- Download URL: filepilot-0.2.0-py3-none-any.whl
- Upload date:
- Size: 16.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71d8ea96e8a801cc78054b47aca91fd0d5d8d9f3e5e5daec87630957933bc033 |
|
MD5 | 65ab7d62c33f81433a289307a5f28a23 |
|
BLAKE2b-256 | eadfb95f54b1f2e7eba787bf14f75b537c8daa902d7dd2160890113a300aaf0f |