3 | 
4 |
5 | GitWit is a container-based agent specialized in making useful commits to git repositories. Given a description (i.e. "implement dark mode") it either checks out a repository or creates a new one, makes these changes, and then pushes the changes to master. (Skip to [How it works](#how-it-works).)
6 |
7 | Given there exist [a few agents](https://github.com/jamesmurdza/awesome-ai-devtools#pr-agents) with a similar purpose—**why is GitWit different?** GitWit interacts with the filesystem in a temporary sandbox and thus can run any shell command. It _writes code that writes code_. This makes it very flexible and repurposable for a number of interesting use cases.
8 |
9 | This agent is also live for testing at [app.gitwit.dev](https://app.gitwit.dev) and has generated over 1000 repositories!
10 |
11 | ### Contents
12 | - [How to run it](#how-to-run-it)
13 | - [Commands](#commands)
14 | - [Examples](#examples)
15 | - [Demos](#demos)
16 | - [Additional configuration](#additional-configuration)
17 | - [LLM configuration](#llm-configuration)
18 | - [How it works](#how-it-works)
19 |
20 | ## How to run it
21 |
22 | Before you start:
23 | 1. You need NodeJS (v18).
24 | 2. You need Docker.
25 | 3. The agent will access to your GitHub account via [personal access token](https://github.com/settings/tokens).
26 | 4. You need an [OpenAI API key](https://platform.openai.com/account/api-keys).
27 |
28 | Setup:
29 | 1. `git clone https://github.com/jamesmurdza/gitwit && cd gitwit` to clone this repository.
30 | 2. `cp .env.example .env` to create a .env file. Update **GITHUB_USERNAME**, **GITHUB_TOKEN** and **OPENAI_API_KEY** with your values.
31 | 3. Start Docker! (GitWit creates a temporary Docker container for each run.) The easiest way to do this locally is with Docker Desktop. See here to connect to a remote docker server.
32 | 4. `docker pull node:latest` to download the base Docker image.
33 | 5. `run npm install` to install dependencies.
34 |
35 | You are ready to go!
36 |
37 | ## Commands
38 |
39 | Generate a new GitHub repository:
40 |
41 | `npm run start`
42 |
43 | Generate a repository with the same name and description as the last run:
44 |
45 | `npm run start -- --again`
46 |
47 | Generate a repository with the same name, description, and build script as the last run:
48 |
49 | `npm run start -- --offline`
50 |
51 | Debug the build script from the last run:
52 |
53 | `npm run start -- --offline --debug`
54 |
55 | Generate a new branch on an existing repository:
56 |
57 | `npm run start -- --branch`
58 |
59 | Generate a new branch with the same name and description as the last run:
60 |
61 | `npm run start -- --branch --again`
62 |
63 | ## Examples
64 |
65 | Articles and tutorials:
66 |
67 | - [Building a Chrome Extension from Scratch using GitWit](https://codesphere.com/articles/building-a-chrome-extension-using-gitwit)
68 |
69 | Examples of entire repositories generated with GitWit:
70 |
71 | - [gitwitapp/doodle-app](https://github.com/gitwitapp/doodle-app): HTML/JS drawing app.
72 | - [gitwitapp/cached-http-proxy-server](https://github.com/gitwitapp/cached-http-proxy-server): NodeJS proxy server with caching.
73 | - [gitwitapp/reddit-news-viewer](https://github.com/gitwitapp/reddit-news-viewer): Python script for scraping Reddit headlines.
74 | - [gitwitapp/python-discord-chatbot](https://github.com/gitwitapp/python-discord-chatbot): Simple Discord bot written in Python.
75 | - [gitwitapp/live-BTC-ticker](https://github.com/gitwitapp/live-BTC-ticker): ReactJS app using d3.js to chart BTC prices.
76 | - [gitwitapp/web-calculator](https://github.com/gitwitapp/web-calculator): Simple HTML/JS calculator.
77 | - [gitwitapp/customer-oop-demo](https://github.com/gitwitapp/customer-oop-demo): Example of generated unit tests.
78 |
79 | ## Demos
80 |
81 | The agent has two modes:
82 | - Create new **repository**: Given a prompt and a repository name, spawn the repository
83 |
84 | https://github.com/gitwitdev/gitwitdev.github.io/assets/33395784/55537249-c301-4e13-84e5-0cdb06174071
85 |
86 | - Create new **branch**: Given a prompt, an existing repository and a branch name, spawn the new branch
87 |
88 | https://github.com/gitwitdev/gitwitdev.github.io/assets/33395784/9315a17c-fc72-431a-a648-16ba42938faa
89 |
90 | ## Additional configuration
91 |
92 | To add new repositories to a GitHub organization:
93 | ```sh
94 | GITHUB_ORGNAME=mygithuborg
95 | ```
96 |
97 | To use a remote Docker server:
98 | ```sh
99 | DOCKER_API_HOST=1.2.3.4
100 | DOCKER_API_PORT=2375
101 | DOCKER_API_KEY=-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----
102 | DOCKER_API_CA=-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----
103 | DOCKER_API_CERT=-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----
104 | ```
105 |
106 | To enable logging or caching with Helicone:
107 | ```sh
108 | # Required:
109 | OPENAI_BASE_URL=https://oai.hconeai.com/v1
110 | HELICONE_API_KEY=sk-xxxxxxx-xxxxxxx-xxxxxxx-xxxxxxx
111 | # Optional:
112 | # OPENAI_CACHE_ENABLED=true
113 | ```
114 |
115 | ## LLM configuration
116 |
117 | By default, GitWit Agent is set to use the OpenAI API with gpt-3.5-turbo and a temperature setting of 0.2. These settings can be configured in [index.js](https://github.com/jamesmurdza/gitwit-agent/blob/main/index.ts).
118 |
119 | GitWit can also be used with LangChain to compose any LangChain supported [chat model](https://js.langchain.com/docs/modules/model_io/models/chat/). An example of this is in [llm.js](https://github.com/jamesmurdza/gitwit-agent/blob/langchain/llm.ts) on the [langchain](https://github.com/jamesmurdza/gitwit-agent/tree/langchain) branch.
120 |
121 | ## How it works
122 |
123 | 127 | This shows the various APIs and connections in the program. 128 |
129 |130 | Code generator: (index.ts) This is the central component that contains the logic necessary to create a new repository or branch. 131 |
132 |133 | OpenAI API: (openai.ts) This is a wrapper functions I wrote around the OpenAI chat completion API. 134 |
135 |136 | GitHub API: (github.ts) This is a collection of wrapper functions I wrote around the GitHub API. 137 |
138 |139 | Docker/Container: (container.ts) This is a collection of wrapper functions I wrote around dockerode to simplify interacting with a Docker server 140 |
141 |142 | Git Repository: (scripts.ts) This is a collection of shell scripts that are injected into the container in order to perform basic git operations. 143 |
144 |
147 | Overview of the system and its parts
148 |153 | This diagram shows a sequential breakdown of the steps in index.ts. A user prompt is used to generate a plan, which is then used to generate a shell script which is run in the container. 154 |
155 |156 | Note: This diagram is for the "branch creation" mode. The equivalent diagram for "repository generation" mode would have "Create a new repo" for Step 1, and Step 2 would be removed. That's because the main purpose of the plan is to selectively decide which files to inject in the context of the final LLM call. 157 |
158 |159 | We select entire files that should or should not be included in the context of the final LLM call, a simple implementation of retrieval-augmented generation! 160 |
161 |
164 | Overview of the agentic process
165 |