TBNilles
1a2ad98c33
Runnable skeleton per AGENT.md: Echo server (/, /help, /healthz, /api/repos), read-only repo scanner with in-memory index, the internal/git boundary, the <repo-list> web component with design tokens, and dev tooling (Dockerfile, docker-compose, air, .env.example). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
60 lines
2.1 KiB
HTML
60 lines
2.1 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>GitManager — Help</title>
|
|
<link rel="stylesheet" href="/static/app.css">
|
|
<style>
|
|
header {
|
|
display: flex; align-items: baseline; gap: 16px;
|
|
padding: 12px 20px; background: var(--surface-1);
|
|
border-bottom: 1px solid var(--border);
|
|
}
|
|
header h1 { margin: 0; font-size: 16px; }
|
|
header nav { margin-left: auto; }
|
|
main { max-width: 760px; padding: 20px; }
|
|
h2 { font-size: 15px; margin-top: 28px; }
|
|
code { background: var(--surface-2); padding: 1px 5px; border-radius: var(--radius-sm); }
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<h1>GitManager</h1>
|
|
<nav><a href="/">← Dashboard</a></nav>
|
|
</header>
|
|
<main>
|
|
<h1>Using GitManager</h1>
|
|
<p>
|
|
GitManager scans the folders you configure and shows every Git repository
|
|
it finds, with each repo's current branch, whether it has uncommitted
|
|
changes, and how far ahead or behind its upstream it is.
|
|
</p>
|
|
|
|
<h2>Getting started</h2>
|
|
<ol>
|
|
<li>Copy <code>.env.example</code> to <code>.env</code>.</li>
|
|
<li>Set <code>GIT_REPO_ROOTS</code> to the folders that hold your repos.</li>
|
|
<li>Run <code>docker compose up</code> and open the dashboard.</li>
|
|
</ol>
|
|
|
|
<h2>Reading the dashboard</h2>
|
|
<ul>
|
|
<li><strong>Branch</strong> — the checked-out branch (or <code>HEAD</code> when detached).</li>
|
|
<li><strong>Dirty</strong> — the working tree has staged or unstaged changes.</li>
|
|
<li><strong>Ahead / behind</strong> — commits your branch leads or trails its upstream by.</li>
|
|
</ul>
|
|
|
|
<h2>Background refresh</h2>
|
|
<p>
|
|
The dashboard refreshes on its own. By default it does <em>not</em> reach
|
|
the network — enable <code>SCAN_FETCH_ENABLED</code> if you want
|
|
ahead/behind counts kept current via <code>git fetch</code>.
|
|
</p>
|
|
|
|
<!-- Keep this page task-oriented and update it whenever a user-facing
|
|
feature changes, in the same change (AGENT.md §9.3). -->
|
|
</main>
|
|
</body>
|
|
</html>
|