Overview

Floe is an AI writing assistant designed for the CLI/CI environment to assist users in creating technical content like documentation and changelogs with improved quality and reduced effort.

Features

• Reviews: Write custom rules in plain English for Floe to automatically review and provide feedback on your content.
• First Draft (Coming soon): Generate an initial draft of your content based on PR context and customizable templates.

Installation

To install Floe, you can follow these steps:

1. Clone the GitHub repository: git clone https://github.com/Floe-dev/floe.git
2. Install dependencies: npm install
3. Start the application: npm start

Summary

Floe is an AI writing assistant tailored for the CLI/CI environment, offering features like content reviews and the upcoming first draft generation. It leverages technologies like Next.js, React.js, Tailwind CSS, Prisma.io, and Turborepo to provide a seamless experience for users. The project is open to contributions, and users can refer to the Floe documentation to begin using the tool effectively.