@aakrit512/gatekeep 1.0.0 → 1.0.2

package/README.md

@@ -1,46 +1,70 @@
 # Gatekeep
 
-A local, browser-based coding agent for reviewing and exploring projects with an OpenAI-compatible chat model. It runs on your machine, keeps project metadata and chat history in a local SQLite database, and gives the model a small set of read/review tools for inspecting a repository.
+Gatekeep is a local web app for reviewing codebases with an OpenAI-compatible model.  
+It runs on your machine, keeps project/chat history locally, and helps you initialize and inspect repositories safely.
 
-## What It Does
+## What You Get
 
-- Starts a local web UI for saved projects and project chat.
-- Initializes a project by creating `docs/intro.md` inside the target repository.
-- Stores project metadata, chat messages, tool traces, token usage, and estimated costs locally.
-- Lets you run provider/config/project doctor checks from the browser.
-- Supports OpenAI-compatible providers through `AI_API_KEY`, `AI_BASE_URL`, and `MODEL_NAME`.
+- Local browser UI for project setup and chat-based review.
+- One-click project initialization that creates `docs/intro.md` in the selected repo.
+- Built-in Doctor checks for Node runtime, API config, and project path readiness.
+- Local storage for project history, tool traces, token usage, and estimated cost.
 
-## Quick Start
+## Requirements
+
+- Node.js `20+`
+- An OpenAI-compatible API key
+
+## Install
+
+Install from npm (recommended):
+
+```sh
+npm install --global @aakrit512/gatekeep
+```
+
+Or run from source:
 
 ```sh
 pnpm install
 pnpm run build
 pnpm link --global
-gatekeep start --project /path/to/repo
 ```
 
-The UI starts at:
+## Start Gatekeep
 
-```txt
-http://127.0.0.1:9808
+```sh
+gatekeep start --project /path/to/repo
 ```
 
-You can also launch it for the current directory:
+Defaults:
+
+- Host: `127.0.0.1`
+- Port: `9808`
+
+You can also run:
 
 ```sh
 gatekeep start --project .
+gatekeep start --port 9809 --host 0.0.0.0
 ```
 
-After publishing to npm, install and run it globally:
+Then open `http://127.0.0.1:9808`.
 
-```sh
-npm install --global @aakrit512/gatekeep
-gatekeep start
-```
+## First-Run Setup (In the UI)
 
-## Configuration
+1. Choose a project directory.
+2. Open **Config** and set:
+   - `AI_API_KEY`
+   - `AI_BASE_URL` (for example `https://api.openai.com/v1`)
+   - `MODEL_NAME` (for example `gpt-4o`)
+3. Run **Doctor** and fix any reported issues.
+4. Click **Initialize** to generate `docs/intro.md`.
+5. Start chatting in the review panel.
 
-Create a local `.env` file or configure values in the browser UI:
+## Environment Variables
+
+You can set config through `.env` (or UI settings):
 
 ```sh
 AI_API_KEY=your_api_key
@@ -48,44 +72,20 @@ AI_BASE_URL=https://api.openai.com/v1
 MODEL_NAME=gpt-4o
 ```
 
-Project metadata and chat history are stored in your OS app-support/config directory, not in the project being reviewed. API keys are masked in UI responses and are not stored in the project database.
-
-## Folder Structure
-
-```txt
-.
-├── src/
-│   ├── ai/          OpenAI client setup, chat completion calls, context trimming, summarization helpers.
-│   ├── cli/         User config storage and validation/doctor checks.
-│   ├── functions/   Tool definitions and local tool execution used by the agent.
-│   ├── prompts/     System and initialization prompts that guide repository review behavior.
-│   ├── ui/          Local HTTP server, project database layer, and browser-agent workflow.
-│   ├── cli.ts       CLI entry point that starts the web UI.
-│   └── config.ts    Shared runtime configuration defaults and helpers.
-├── ui/
-│   └── app.html     Browser UI document, styles, and client-side JavaScript.
-├── package.json     Package metadata, scripts, dependencies, and publish file list.
-├── tsconfig.json    TypeScript settings for development type checks.
-├── tsconfig.build.json
-│                  TypeScript build settings for emitted `dist/` output.
-├── pnpm-lock.yaml   Locked dependency graph.
-└── pnpm-workspace.yaml
-                   pnpm workspace declaration.
-```
+## Local Data and Privacy
 
-`dist/`, `node_modules/`, local `.env` files, and SQLite runtime files are generated locally and intentionally ignored by git.
+Gatekeep stores data under your OS config/app-support directory:
 
-## Scripts
+- `config.json` for provider/model/base URL/API key
+- `projects.sqlite` for projects, chat history, activity traces, and usage
 
-```sh
-pnpm run start      # Run the TypeScript CLI directly with tsx.
-pnpm run build      # Compile TypeScript into dist/.
-pnpm pack           # Build and create the installable npm tarball.
-pnpm run typecheck  # Type-check without emitting files.
-```
-
-## Development Notes
+Nothing is uploaded except model API requests sent to your configured provider.
 
-The browser UI is intentionally plain HTML so the package stays small and the server can serve it without a frontend build step. The server injects the curated fallback model list into `ui/app.html` at request time.
+## Common Commands
 
-The agent tools are scoped to repository inspection and project initialization. During normal review/chat workflows, the model is guided to inspect files and diffs before answering.
+```sh
+gatekeep --help
+gatekeep start
+gatekeep start --project .
+pnpm run typecheck
+```

package/dist/functions/toolExecutor.js

@@ -1,4 +1,4 @@
-import { execFileSync, execSync } from 'child_process';
+import { execFileSync } from 'child_process';
 import { createHash } from 'crypto';
 import * as fs from 'fs';
 import * as path from 'path';
@@ -1016,18 +1016,22 @@ export function executeTool(name, args) {
             return `Success: Wrote ${content.length} characters to ${filePath}`;
         }
         if (name === 'get_git_diff') {
-            // Helper: run a git command and return stdout, or '' on failure (e.g. no commits yet)
-            const tryGit = (cmd) => {
+            // Helper: run git subcommands without shell evaluation and return stdout.
+            const tryGit = (args) => {
                 try {
-                    return execSync(cmd, { stdio: ['pipe', 'pipe', 'pipe'] }).toString().trim();
+                    return execFileSync('git', args, {
+                        cwd: process.cwd(),
+                        encoding: 'utf-8',
+                        stdio: ['pipe', 'pipe', 'pipe'],
+                    }).trim();
                 }
                 catch {
                     return '';
                 }
             };
-            const working = tryGit('git diff');
-            const staged = tryGit('git diff --cached');
-            const log = tryGit('git log --oneline --stat -10');
+            const working = tryGit(['diff']);
+            const staged = tryGit(['diff', '--cached']);
+            const log = tryGit(['log', '--oneline', '--stat', '-10']);
             const sections = [
                 `## Uncommitted changes (working tree)\n${working || 'None.'}`,
                 `## Staged changes (index)\n${staged || 'None.'}`,

package/dist/ui/server.js

@@ -112,34 +112,12 @@ function buildConfigFromBody(body) {
 function uniqueStrings(values) {
     return [...new Set(values.map((value) => value.trim()).filter(Boolean))];
 }
-function modelListUrl(baseUrl) {
-    const normalized = baseUrl.endsWith('/') ? baseUrl : `${baseUrl}/`;
-    return new URL('models', normalized).toString();
-}
 async function listModels(config) {
     const fallback = uniqueStrings([config.model, ...CURATED_OPENAI_MODELS]);
     if (!config.apiKey.trim()) {
-        return { models: fallback, source: 'fallback', warning: 'Add an API key to load account models.' };
-    }
-    const response = await fetch(modelListUrl(config.baseUrl), {
-        headers: {
-            authorization: `Bearer ${config.apiKey}`,
-        },
-    });
-    if (!response.ok) {
-        return {
-            models: fallback,
-            source: 'fallback',
-            warning: `Could not load models (${response.status}).`,
-        };
+        return { models: fallback, source: 'static', warning: 'Add an API key to chat with the model you choose.' };
     }
-    const body = await response.json();
-    const available = new Set((body.data || []).map((model) => typeof model.id === 'string' ? model.id : '').filter(Boolean));
-    const models = uniqueStrings([
-        config.model,
-        ...CURATED_OPENAI_MODELS.filter((model) => available.has(model)),
-    ]);
-    return { models: models.length ? models : fallback, source: 'api' };
+    return { models: fallback, source: 'static' };
 }
 function pickDirectory() {
     return new Promise((resolve, reject) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aakrit512/gatekeep",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A local browser-based coding agent for project review and chat.",
   "main": "./dist/cli.js",
   "bin": {