Skip to main content

Agent for generating and applying AI-powered coding prompts in your repository via a web UI

Project description

AiChatCoder Agent

Agent for generating and applying AI-powered coding prompts in your repository via a web UI at www.aichatcoder.com.

The AiChatCoder Agent is a command-line tool that runs locally in your repository as part of the AiChatCoder system. It generates tailored AI prompts based on your codebase, which you can copy to a chat model (e.g., ChatGPT) via the web UI at www.aichatcoder.com. After receiving the chat response, the agent applies the suggested changes to your files, streamlining your coding workflow.

Overview

AiChatCoder is a system designed for developers to integrate AI assistance into their coding process. The system consists of two main components:

  • AiChatCoder Agent (this pip package): A local agent that runs in your repository to generate prompts and apply changes.
  • AiChatCoder Web UI (www.aichatcoder.com): A web interface for controlling the agent, generating prompts, and managing chat responses.

Workflow (Prototype)

  1. Run the Agent Locally: Use the aichatcoder CLI to start the agent in your repository.

  2. Control via Web UI: Open the web UI at www.aichatcoder.com, write a prompt (or use the agent’s suggestions), and hit "Generate."

  3. Generate Prompts: The agent analyzes your codebase and generates specific AI prompts, which are displayed in the web UI for you to copy.

  4. Interact with Chat Model: Copy the generated prompt to a chat model (e.g., ChatGPT). The chat model responds with code or instructions in a specific format.

  5. Apply Changes: Copy the chat response back to the web UI. The web UI sends the response to the agent, which applies the changes to your repository files.

Installation

AiChatCoder requires Python 3.8+ to be installed on your system. Follow the steps below for your platform:

Windows

  1. Download and install Python 3.8+ from python.org.
  2. Open a command prompt and install AiChatCoder:
    pip install aichatcoder
    

Linux (e.g., Ubuntu)

  1. Python 3 is usually pre-installed. Check with python3 --version.
  2. If pip is not installed, run:
    sudo apt update
    sudo apt install python3-pip
    
  3. Install AiChatCoder:
    pip install aichatcoder
    

Mac (ARM/Intel)

  1. macOS 12.3+ does not include Python by default. Download and install Python 3.8+ from python.org, or use Homebrew:
    brew install python
    
  2. Install AiChatCoder:
    pip install aichatcoder
    

Usage

This package provides a CLI for running the agent in your repository. The web UI at www.aichatcoder.com is required to control the agent and manage the workflow.

Global Configuration

AiChatCoder stores a global configuration file in YAML format at the following location:

  • Linux/Mac: ~/.aichatcoder/config.yml
  • Windows: C:\Users\<Username>\.aichatcoder\config.yml

The configuration file stores your web auth token, which is required to connect to the AiChatCoder web UI.

First Run Setup

The first time you run aichatcoder init, you’ll be prompted to provide a web auth token if it’s not already set in the configuration file. You can obtain your web auth token by logging in with your GitHub account at www.aichatcoder.com

Check for Updates

When you run aichatcoder init or aichatcoder run, the CLI will check for updates on PyPI. If a newer version is available, you’ll be prompted to update.

Initialize the Agent

aichatcoder init

This sets up the agent in your current repository. If a web auth token is not set, you’ll be prompted to provide one.

Run the Agent

aichatcoder run

This starts the agent, which will connect to the web UI and prepare to generate prompts and apply changes. If a web auth token is not set, you’ll be prompted to run aichatcoder init to set it up.

License

The AiChatCoder Agent is licensed under a custom "No Usage" License. This package is made public for transparency and security review purposes only. Usage, modification, or distribution of this package by others is strictly prohibited. See the LICENSE file for details.

Credits

Created by therceman.

Links

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

aichatcoder-0.0.3.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aichatcoder-0.0.3-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file aichatcoder-0.0.3.tar.gz.

File metadata

  • Download URL: aichatcoder-0.0.3.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for aichatcoder-0.0.3.tar.gz
Algorithm Hash digest
SHA256 b1f01630008f17ffa0345e3ea59f32f19ac68dd71df988e6a27a9cbf167374b8
MD5 228a3ec208e932caa4439072a30154ac
BLAKE2b-256 d308f9e1894933a717144475ea4f2b40ae05ad58349159c2f65850335bde5954

See more details on using hashes here.

File details

Details for the file aichatcoder-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: aichatcoder-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for aichatcoder-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f159b5b4d5410a052b42d64326f16fdf65814570b4343c6daf2629d8c0442833
MD5 c82280fe620d09b77964e738b9f552f2
BLAKE2b-256 ad2445ab493a574c94d5112f91b12e1c6c63a885aefd904429638175f835d5c5

See more details on using hashes here.

Supported by

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