Now in v1.0

Architecture docs
that stay true to your code.

Archie reads your codebase, analyzes your Git history, and keeps ARCHITECTURE.md accurate — updating only what changed, on every meaningful commit.

npm install -g archie-ai See how it works

New Commit

feat: add billing module

Watching for commits...Post-commit hook active

ARCHITECTURE.md

## Core Architecture

awaiting changes...

How Archie Works

Three commands. Then Archie runs quietly in the background — you commit, it documents.

❯

archie init

Reads your source files, project identity files, and recent Git history. Sends everything to Gemini 2.5 Flash in a single request. Writes a structured ARCHITECTURE.md in seconds.

❯archie hook

archie hook

Installs a post-commit hook. After every commit, Archie checks whether the changes are significant. If they are, it updates only the affected sections - not a full rewrite.

git commit (normal)

Your commits work exactly as before. Archie runs asynchronously after the commit completes - zero added latency. Use --no-verify to skip it on any specific commit.

Surgical precision. Zero filler.

Archie doesn't regenerate your docs from scratch — it identifies exactly which architectural decisions changed and rewrites only those sections.

ARCHITECTURE.md

+3−1

 ## Tech Stack
  
 - **Commander.js**: Used in `src/index.ts` to define
   CLI commands. Chosen for its mature, simple API.
  
−- **simple-git**: Wraps Git operations for reading history.
+- **simple-git**: Wraps Git operations. Used in `gitReader.ts`
+  and `fileReader.ts` for commit diffs and file tree traversal.
  
 - **dotenv**: Loads `GEMINI_API_KEY` from `.env`.
  
 - **@google/generative-ai**: Official Gemini client. Chosen
   for its 1M token context window — no chunking required.
  
 - **Commander.js**: Used in `src/index.ts` to define
   CLI commands. Chosen for its mature, simple API.
  
−- **simple-git**: Wraps Git operations for reading history.
+- **simple-git**: Wraps Git operations. Used in `gitReader.ts`
+  and `fileReader.ts` for commit diffs and file tree traversal.
  
 - **dotenv**: Loads `GEMINI_API_KEY` from `.env`.

Intent Analysis

Detected separation of concern. The authentication module was decoupled from the core API gateway into a standalone microservice.

Confidence98.4%

Historical Context

Previous State (HEAD~1)

gateway.ts handled JWT

New State (HEAD)

auth-service/ initiated

Frequently Asked Questions

Everything you need to know about how Archie works.

Q.01

Will Archie commit ARCHITECTURE.md automatically?

No — Archie writes the file to disk but never stages or commits it. You stay in full control of what gets committed.

Q.02

Does the Git hook slow down my commits?

No — the post-commit hook runs asynchronously after the commit completes. Zero added latency to your workflow.

Q.03

How do I skip the hook on a specific commit?

Use git commit --no-verify to bypass the hook for any individual commit.

Q.04

Is my code sent to Google?

Yes — source files are sent to the Gemini 2.5 Flash API. Review Google's API data usage policy at https://ai.google.dev/gemini-api/terms before use.

Q.05

What does Archie do if a change isn't significant?

It silently advances its internal state pointer and exits. Only meaningful changes — like a modified package.json or 5+ file edits — trigger a doc update.

Initialization

Three commands.
Docs that keep up.

Install globally, point Archie at your Gemini key, and run init. From that point on, every meaningful commit updates your architecture doc automatically — no manual steps, no scheduled jobs.

Gemini AI Integration

Your code diffs are routed to Google's Gemini API for analysis. Get a free API key · Usage policy

~/workspace/project

❯Install Archie globally

npm install -g archie-ai

❯Add your Gemini API key

echo "GEMINI_API_KEY=your_key_here" > .env

❯Generate your first ARCHITECTURE.md

archie init

❯

Architecture docsthat stay true to your code.