Skip to main content

AI Code Review Automation Tool

Project description

Codara Code Review and Diagnostics Tool

This script assists in AI code review and diagnosis by using tailored AI models to intelligently provide suggestions and improvements. Purchase a subscription at codara.io

Subscribe to use this tool: codara.io

These prices directly help us with the AI costs related to running the model

Plan Price Description Link
Basic $4/month - 14 day free trial
- unlimited reviews
- diagnostic feature
- review unstaged code
- locally saved reviews
Free Trial

Features

  • Review the code differences between two branches in a Git repository.
  • Review unstaged code diffs.
  • Generate a formatted review file with a timestamp and the branch commit hash.
  • Diagnose code issues directly in the terminal by providing the command to debug.

Prerequisites

  • Python 3.6 or later.
  • Git must be installed and configured on the system where the script is executed.

Installation

pip install codara

Help and Documentation

codara --help

Login

an active subscription is required to use this tool: codara.io

register or login with the below command using the same email used to purchase your subscription

codara --login

Usage

To use the AI review feature run the following command:

codara review --unstaged

or the short version (shorthands available for all commands)

codara review -u

or review between two branches like a pull request

codara review --target <target_branch>

get help

codara review --help

To use the AI diagnostic feature run the following command:

codara diagnose "<command-producing-error>"

get help

codara diagnose --help

Output

The AI reviewer will create a new file in the reviews directory with the review output. The file will be named using the source and target branch names, their respective commit hashes, and a timestamp.

The AI diagnostics will create a new file in the diagnostics directory with the diagnostic output. The file will be named using the command provided and a timestamp.

Example review filename: feature-branch_abc123_to_main_def456_2023-11-15_23-31-56.txt

Example diagnostic filename: diagnose_command_2023-11-15_23-31-56.txt

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

codara-2.0.6.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

codara-2.0.6-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file codara-2.0.6.tar.gz.

File metadata

  • Download URL: codara-2.0.6.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.10

File hashes

Hashes for codara-2.0.6.tar.gz
Algorithm Hash digest
SHA256 3b02348d2658d9745c9891996de0a2ee15aac37a5128b665c62482eaa831c5e7
MD5 9ea80249064f31ff911057a357cafdc4
BLAKE2b-256 eeeea87df6db5f6086f93a4ea341ab80f8ece0931cb8d38a19c06ccc0307e4f9

See more details on using hashes here.

File details

Details for the file codara-2.0.6-py3-none-any.whl.

File metadata

  • Download URL: codara-2.0.6-py3-none-any.whl
  • Upload date:
  • Size: 20.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.10

File hashes

Hashes for codara-2.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5b2d6bb33071ced4149fabd051de27fe5c9f86ae7ae65774b039897367f89dc7
MD5 589035693f2e9b28ee93f9c13cfaccff
BLAKE2b-256 fffb95a0aae65e1174c3ed5db3bdf28c1f31fb60804ee66c7373eb019b23a3ea

See more details on using hashes here.

Supported by

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