npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gpt-repo

v0.0.7

Published

A powerful CLI tool that leverages OpenAI's GPT models to operate on code repositories.

Downloads

195

Readme

GPT-Repo - 🛠️ CLI Codebase Explainer & Coding Agent

License npm version Downloads

GPT-Repo is a powerful CLI tool written in TypeScript that leverages OpenAI's GPT models to:

  • Summarize Large Codebases: Overcome context-window limitations by summarizing files, then summaries of files, and summaries of summaries, into one comprehensive report.
  • 🤖 Automate Code Modifications: Acts as an agent that can modify source files, create/delete files, execute shell commands, and perform tasks akin to a software engineer.

NOTE: This project is in a very early stage.


Table of Contents


Features

  • Codebase Summarization: Generate hierarchical summaries of large codebases to get insights that exceed the GPT model's context window.
  • Automated Coding Agent: Perform code modifications, file operations, and execute shell commands through an intelligent agent.
  • Customizable Prompts: Use Handlebars templates for prompt customization.

Prerequisites

  • Node.js: Version >=16.0.0 (v23.0.0 recommended via nvmrc)
  • npm: Version >=6.0.0
  • pnpm: Installed globally (npm install -g pnpm)
  • OpenAI API Key: Required for GPT model access.

CLI

Install the package globally with npm or your package manager of choice:

npm i -g gpt-repo

This provides the two commands gpt-repo-summarise and gpt-repo-auto.

Developing

Clone the repository and install dependencies:

git clone https://github.com/f3rno64/gpt-repo.git
cd gpt-repo
pnpm install

Setup

First, export your OpenAI API Key as an environment variable, or provide it in a .env file:

export OPENAI_API_KEY=your_openai_api_key
echo 'OPENAI_API_KEY=your_openai_api_key' >> .env

Then, build the project with pnpm build.

Usage

Summarizing Codebases

To summarize a codebase, navigate to your project directory and run:

cd /path/to/your/project
gpt-repo-summarise src package.json README.md

This will generate a comprehensive summary of the specified files and directories.

Running the Agent

To run the coding agent, execute:

cd /path/to/your/project
gpt-repo-auto src package.json README.md

The agent will perform tasks based on the provided files and directories.

Examples

Summarize a Single File:

gpt-repo-summarise src/index.ts

Run Agent on Multiple Directories:

gpt-repo-auto src tests

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature/your-feature-name.
  3. Commit your changes: git commit -m 'Add some feature'.
  4. Push to the branch: git push origin feature/your-feature-name.
  5. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.