Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skarllot/flow-pair

Personal pair programming with CI&T Flow AI
https://github.com/skarllot/flow-pair

anthropic chatgpt ciandt claude-ai flow openai

Last synced: 17 days ago
JSON representation

Personal pair programming with CI&T Flow AI

Host: GitHub
URL: https://github.com/skarllot/flow-pair
Owner: skarllot
License: mit
Created: 2024-12-17T00:31:42.000Z (21 days ago)
Default Branch: main
Last Pushed: 2024-12-20T13:24:50.000Z (17 days ago)
Last Synced: 2024-12-20T13:46:45.567Z (17 days ago)
Topics: anthropic, chatgpt, ciandt, claude-ai, flow, openai
Language: C#
Homepage:
Size: 118 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

# FlowPair

_FlowPair provides automated code review and feedback using CI&T Flow AI through a command-line interface._

[![Build status](https://github.com/skarllot/flow-pair/actions/workflows/dotnet.yml/badge.svg?branch=main)](https://github.com/skarllot/flow-pair/actions)
[![GitHub Release](https://img.shields.io/github/v/release/skarllot/flow-pair)](https://github.com/skarllot/flow-pair/releases)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/skarllot/flow-pair/main/LICENSE)

## About

FlowPair is a CLI tool that leverages CI&T's Flow AI to provide automated code reviews. It detects Git staged (or unstaged) changes and generates insightful feedback, enhancing your development process with AI-powered assistance.

## Features

- Automated code review for Git changes
- AI-powered feedback generation
- HTML report output for easy review
- Simple configuration and usage

## Installation

1. Download the latest version of FlowPair from the [releases page](https://github.com/skarllot/flow-pair/releases).

2. Extract the downloaded archive to a directory of your choice.

3. Add the FlowPair directory to your system's PATH.

4. Open a terminal and run the following command to verify the installation:

```bash
flowpair --version
```

## Configuration

To configure FlowPair, run:

```bash
flowpair configure
```

You will be prompted to provide the following information:

- Tenant
- Client ID
- Client Secret

These credentials are necessary for authenticating with the CI&T Flow AI service.

## Usage

To review your Git changes and receive feedback, simply run:

```bash
flowpair review
```

This command will:
1. Detect Git staged (or unstaged) changes in your current repository
2. Send the changes to CI&T Flow AI for review
3. Generate an HTML file with the feedback
4. Automatically open the HTML report in your default web browser

This streamlined process allows you to quickly view and act on the AI-generated feedback for your code changes.

## Documentation

For more detailed information on how to use FlowPair and its features, please refer to our [GitHub wiki](https://github.com/skarllot/flow-pair/wiki).

## Contributing

We welcome contributions to FlowPair! If you have suggestions for improvements or encounter any issues, please feel free to:

- Open an [issue](https://github.com/skarllot/flow-pair/issues)
- Submit a [pull request](https://github.com/skarllot/flow-pair/pulls)

Before contributing, please read our [contribution guidelines](CONTRIBUTING.md).

## Support

If you need help, have any questions, or want to report issues:

- Use our [GitHub Issues](https://github.com/skarllot/flow-pair/issues) page to report problems or seek assistance

## License

FlowPair is licensed under the [MIT License](./LICENSE).