Documentation that stays in sync
with your local git repository.

Point Penqwin at your local git repository and automatically generate documentation you can trust, without your code ever leaving your machine.

Star on GitHub Download for Windows

Penqwin - Professional Engineering Documentation Platform

Acme Corp

Global Search

⌘ + K

Changeset Summary

Code Reference

src

app

auth

api

API & Endpoints

core

services

store

database

Guides

Authentication

Agentic AI

+ Create

Update Docs

Regenerate Doc

Save

Authentication & Authorization

Security is enforced at the route level through server-side session validation. Most endpoints utilize the createClient utility to interact with database, ensuring that data access respects the authenticated user's permissions.

Administrative Access

For operations that require cross-workspace visibility, state transitions that bypass high-level configuration changes (e.g., repository mapping discovery), the system utilizes superiorClient.

Authorization

is further refined by checkRole, which distinguishes between admin, read and write, and read only roles within a workspace.

API Reference

User & Profile

Method	Endpoint	Description
GET	`/api/user/profile`	Returns user data, member workspaces, and their active subscription states.

Member & Request Management

Method	Endpoint	Description
GET	`/api/members`	Lists all members with enriched user profile data.
PATCH	`/api/members/{memberId}`	Updates a member's role (`admin`, `read and write`, `read only`).
DELETE	`/api/members/{memberId}`	Removes a member from the workspace.

Penqwin's Local Knowledge Base is a desktop application that reads your git history and file structure directly from disk, generates full engineering documentation using AI, and stores everything locally in an embedded database. There is no backend, no account required to use the core product, and no code ever leaves your computer.

How It Works

1. Connect Your Repository

Point the app at any local git repository. No cloud connection, GitHub integration, or remote access required — it works entirely from what's already on your disk.

2. Bootstrap Your Repository

Understand your codebase from day one. The app scans your repository structure and organizes it into documentation for your architecture, APIs, modules, and business logic using AI.

3. Evolve with Code Changes

Documentation that evolves with your repository. The app tracks your local commits to calculate diffs, keeping documentation aligned with the actual state of your system without redundant work.

4. Organize by Workspace

Manage multiple projects side by side. Each workspace is fully isolated, so documentation for one repository never mixes with another.

5. Search Instantly, Offline

A built-in full-text search engine indexes titles and rich content locally, with live highlighting — no internet connection required.

6. Edit Alongside the AI

A rich text editor (tables, code blocks, markdown, drag-to-reorder) lets your team refine AI-generated content directly, without switching tools.

Why Local-First Matters

Your Code Stays on Your Machine

There's no upload step. Documentation generation happens by reading files and git history directly from local disk — nothing is transmitted to a remote server for storage.

Works Fully Offline

Once bootstrapped, search, editing, and organization all work without an internet connection. Only AI generation calls require connectivity.

No Infrastructure to Manage

There's no database to provision, no server to patch, and no uptime to monitor. It's a desktop application — install it and it runs.

Built for Regulated and Air-Gapped Environments

Teams under strict data-handling requirements — finance, healthcare, defense, and government contractors — can generate and maintain documentation without violating data residency or network isolation policies.

Who It's For

Solo developers and indie teams who want documentation without paying for or managing a hosted service.
Security-conscious engineering teams that can't send proprietary code to third-party servers.
Consultants and contractors managing multiple isolated client codebases on one machine.
Teams in regulated industries where compliance rules restrict where code and derived data can be processed.

Personal vs. Team

	Personal	Team
Where data lives	Your local machine	Penqwin's managed infrastructure
Setup	Install the desktop app	Connect your GitHub org
Team collaboration	Single-user, per machine	Multi-user, shared workspaces
Best for	Privacy-sensitive, offline, solo use	Teams needing shared, always-on docs
Internet required	Only for AI generation calls	Yes

Frequently Asked Questions

Does the Local Knowledge Base send my code to Penqwin's servers?

No. The app reads your git repository and files directly from local disk. Documentation is generated and stored locally using your own AI provider API key.

Do I need an internet connection to use it?

Only when generating or updating documentation via AI. Browsing, searching, and editing existing docs work fully offline.

Can multiple people on my team use the same local knowledge base?

The local app is designed for single-machine use. Teams that need shared, multi-user documentation should use Penqwin's cloud Knowledge Base instead.

What AI provider does it use?

Documentation generation is powered by Google Gemini. You provide your own API key, which is stored locally.

Documentation that stays in sync with your local git repository.