CodeIssuesDiscussionsWikiPull RequestsProjectsCommitsActionsReleasesContributorsPulse● GatesSecuritySettingsDeploymentsPipelineInsightsAgents✨ Explain✨ Ask AI✨ Workspace✨ Spec✨ Tests▓ Debt Map✨ NL Search🏛 Archaeology
Blame · Line-by-line history
help.tsx
Each line is annotated with the commit that last touched it. Click any SHA to jump to that commit and see the surrounding change.
| 80bed05 | 1 | /** |
| 2 | * /help — public quickstart + API cheatsheet for owners migrating their | |
| 3 | * products onto gluecron. Covers the first five minutes (register, clone, | |
| 4 | * push), integration surfaces (SSH, import, webhooks, tokens), and the | |
| 5 | * AI-native extras (gates + AI review). Linked from the landing page nav. | |
| 6 | * | |
| 7 | * Uses softAuth so the nav bar renders with the signed-in user's session | |
| 8 | * cookie when present; the page itself is reachable without auth. | |
| 9 | */ | |
| 10 | ||
| 11 | import { Hono } from "hono"; | |
| 12 | import { Layout } from "../views/layout"; | |
| 13 | import { softAuth } from "../middleware/auth"; | |
| 14 | import type { AuthEnv } from "../middleware/auth"; | |
| 15 | ||
| 16 | const help = new Hono<AuthEnv>(); | |
| 17 | help.use("*", softAuth); | |
| 18 | ||
| bdb51e4 | 19 | // ─── PAGE-SCOPED CSS ───────────────────────────────────────── |
| 20 | // All classes prefixed with `.help-` so styles cannot bleed into other | |
| 21 | // surfaces. Mirrors the 2026 hero polish in admin, dashboard, import, | |
| 22 | // settings, and repo-settings. | |
| 23 | const helpStyles = ` | |
| 24 | .help-wrap { max-width: 920px; margin: 0 auto; padding: var(--space-6) var(--space-4); } | |
| 25 | ||
| 26 | /* ─── Hero ─── */ | |
| 27 | .help-hero { | |
| 28 | position: relative; | |
| 29 | margin-bottom: var(--space-5); | |
| 30 | padding: var(--space-5) var(--space-6); | |
| 31 | background: var(--bg-elevated); | |
| 32 | border: 1px solid var(--border); | |
| 33 | border-radius: 16px; | |
| 34 | overflow: hidden; | |
| 35 | } | |
| 36 | .help-hero::before { | |
| 37 | content: ''; | |
| 38 | position: absolute; | |
| 39 | top: 0; left: 0; right: 0; | |
| 40 | height: 2px; | |
| 41 | background: linear-gradient(90deg, transparent 0%, #8c6dff 30%, #36c5d6 70%, transparent 100%); | |
| 42 | opacity: 0.75; | |
| 43 | pointer-events: none; | |
| 44 | } | |
| 45 | .help-hero-bg { | |
| 46 | position: absolute; | |
| 47 | inset: -20% -10% auto auto; | |
| 48 | width: 360px; height: 360px; | |
| 49 | pointer-events: none; | |
| 50 | z-index: 0; | |
| 51 | } | |
| 52 | .help-hero-orb { | |
| 53 | position: absolute; | |
| 54 | inset: 0; | |
| 55 | background: radial-gradient(circle, rgba(140,109,255,0.20), rgba(54,197,214,0.10) 45%, transparent 70%); | |
| 56 | filter: blur(80px); | |
| 57 | opacity: 0.7; | |
| 58 | animation: helpHeroOrb 14s ease-in-out infinite; | |
| 59 | } | |
| 60 | @keyframes helpHeroOrb { | |
| 61 | 0%, 100% { transform: scale(1) translate(0, 0); opacity: 0.6; } | |
| 62 | 50% { transform: scale(1.1) translate(-10px, 8px); opacity: 0.85; } | |
| 63 | } | |
| 64 | @media (prefers-reduced-motion: reduce) { | |
| 65 | .help-hero-orb { animation: none; } | |
| 66 | } | |
| 67 | .help-hero-inner { | |
| 68 | position: relative; | |
| 69 | z-index: 1; | |
| 70 | max-width: 680px; | |
| 71 | } | |
| 72 | .help-hero-eyebrow { | |
| 73 | display: inline-flex; | |
| 74 | align-items: center; | |
| 75 | gap: 8px; | |
| 76 | font-size: 12px; | |
| 77 | font-weight: 600; | |
| 78 | letter-spacing: 0.06em; | |
| 79 | text-transform: uppercase; | |
| 80 | color: var(--text-muted); | |
| 81 | margin-bottom: var(--space-3); | |
| 82 | } | |
| 83 | .help-hero-eyebrow-pill { | |
| 84 | display: inline-flex; | |
| 85 | align-items: center; | |
| 86 | justify-content: center; | |
| 87 | width: 22px; height: 22px; | |
| 88 | border-radius: 7px; | |
| 89 | background: linear-gradient(135deg, rgba(140,109,255,0.20), rgba(54,197,214,0.18)); | |
| 90 | box-shadow: inset 0 0 0 1px rgba(140,109,255,0.35); | |
| 91 | color: #c4b6ff; | |
| 92 | font-size: 13px; | |
| 93 | line-height: 1; | |
| 94 | } | |
| 95 | .help-hero-title { | |
| 96 | font-size: clamp(28px, 4vw, 40px); | |
| 97 | font-family: var(--font-display); | |
| 98 | font-weight: 800; | |
| 99 | letter-spacing: -0.028em; | |
| 100 | line-height: 1.05; | |
| 101 | margin: 0 0 var(--space-3); | |
| 102 | color: var(--text-strong); | |
| 103 | } | |
| 104 | .help-hero-title .help-gradient-text { | |
| 105 | background-image: linear-gradient(135deg, #a48bff 0%, #8c6dff 50%, #36c5d6 100%); | |
| 106 | -webkit-background-clip: text; | |
| 107 | background-clip: text; | |
| 108 | -webkit-text-fill-color: transparent; | |
| 109 | color: transparent; | |
| 110 | } | |
| 111 | .help-hero-sub { | |
| 112 | font-size: 15px; | |
| 113 | color: var(--text-muted); | |
| 114 | margin: 0; | |
| 115 | line-height: 1.55; | |
| 116 | max-width: 600px; | |
| 117 | } | |
| 118 | ||
| 119 | /* ─── On-this-page nav ─── */ | |
| 120 | .help-toc { | |
| 121 | position: relative; | |
| 122 | padding: var(--space-4) var(--space-5); | |
| 123 | background: var(--bg-elevated); | |
| 124 | border: 1px solid var(--border); | |
| 125 | border-radius: 14px; | |
| 126 | margin-bottom: var(--space-5); | |
| 127 | } | |
| 128 | .help-toc-label { | |
| 129 | font-size: 11px; | |
| 130 | font-weight: 600; | |
| 131 | letter-spacing: 0.08em; | |
| 132 | text-transform: uppercase; | |
| 133 | color: var(--accent); | |
| 134 | margin-bottom: 10px; | |
| 135 | } | |
| 136 | .help-toc-list { | |
| 137 | display: flex; | |
| 138 | flex-wrap: wrap; | |
| 139 | gap: 8px; | |
| 140 | } | |
| 141 | .help-toc-list a { | |
| 142 | display: inline-flex; | |
| 143 | align-items: center; | |
| 144 | padding: 5px 10px; | |
| 145 | font-size: 12.5px; | |
| 146 | color: var(--text); | |
| 147 | background: var(--bg); | |
| 148 | border: 1px solid var(--border); | |
| 149 | border-radius: 8px; | |
| 150 | text-decoration: none; | |
| 151 | transition: border-color 120ms ease, background 120ms ease, color 120ms ease; | |
| 152 | } | |
| 153 | .help-toc-list a:hover { | |
| 154 | border-color: rgba(140,109,255,0.45); | |
| 155 | background: rgba(140,109,255,0.06); | |
| 156 | color: var(--text-strong); | |
| 157 | } | |
| 158 | ||
| 159 | /* ─── Section cards ─── */ | |
| 160 | .help-section { | |
| 161 | background: var(--bg-elevated); | |
| 162 | border: 1px solid var(--border); | |
| 163 | border-radius: 14px; | |
| 164 | margin-bottom: var(--space-5); | |
| 165 | overflow: hidden; | |
| 166 | scroll-margin-top: var(--space-6); | |
| 167 | } | |
| 168 | .help-section-head { | |
| 169 | padding: var(--space-4) var(--space-5) var(--space-3); | |
| 170 | border-bottom: 1px solid var(--border); | |
| 171 | } | |
| 172 | .help-section-eyebrow { | |
| 173 | font-size: 11px; | |
| 174 | font-weight: 600; | |
| 175 | letter-spacing: 0.08em; | |
| 176 | text-transform: uppercase; | |
| 177 | color: var(--accent); | |
| 178 | margin-bottom: 6px; | |
| 179 | } | |
| 180 | .help-section-title { | |
| 181 | font-family: var(--font-display); | |
| 182 | font-size: 19px; | |
| 183 | font-weight: 700; | |
| 184 | letter-spacing: -0.02em; | |
| 185 | margin: 0 0 4px; | |
| 186 | color: var(--text-strong); | |
| 187 | } | |
| 188 | .help-section-desc { | |
| 189 | font-size: 13.5px; | |
| 190 | color: var(--text-muted); | |
| 191 | margin: 0; | |
| 192 | line-height: 1.5; | |
| 193 | } | |
| 194 | .help-section-body { | |
| 195 | padding: var(--space-4) var(--space-5); | |
| 196 | display: flex; | |
| 197 | flex-direction: column; | |
| 198 | gap: var(--space-3); | |
| 199 | } | |
| 200 | ||
| 201 | /* ─── Item rows inside a section card ─── */ | |
| 202 | .help-item { | |
| 203 | padding: 12px 14px; | |
| 204 | background: var(--bg); | |
| 205 | border: 1px solid var(--border-subtle, var(--border)); | |
| 206 | border-radius: 10px; | |
| 207 | font-size: 14px; | |
| 208 | line-height: 1.55; | |
| 209 | color: var(--text); | |
| 210 | } | |
| 211 | .help-item strong { color: var(--text-strong); font-weight: 600; } | |
| 212 | .help-item code { | |
| 213 | font-family: var(--font-mono, ui-monospace, SFMono-Regular, Menlo, monospace); | |
| 214 | font-size: 12.5px; | |
| 215 | padding: 1px 5px; | |
| 216 | border-radius: 4px; | |
| 217 | background: rgba(140,109,255,0.10); | |
| 218 | color: #c4b6ff; | |
| 219 | } | |
| 220 | .help-item a { color: var(--text-link, var(--accent)); } | |
| 221 | ||
| 222 | /* ─── Code blocks inside items ─── */ | |
| 223 | .help-code { | |
| 224 | margin: 8px 0 0; | |
| 225 | padding: 12px 14px; | |
| 226 | background: #0a0c14; | |
| 227 | border: 1px solid var(--border-subtle, var(--border)); | |
| 228 | border-radius: 8px; | |
| 229 | font-family: var(--font-mono, ui-monospace, SFMono-Regular, Menlo, monospace); | |
| 230 | font-size: 12.5px; | |
| 231 | line-height: 1.55; | |
| 232 | color: #d6d8e3; | |
| 233 | overflow-x: auto; | |
| 234 | } | |
| 235 | ||
| 236 | /* ─── Footer hint ─── */ | |
| 237 | .help-footnote { | |
| 238 | margin-top: var(--space-6); | |
| 239 | padding-top: var(--space-4); | |
| 240 | border-top: 1px solid var(--border); | |
| 241 | color: var(--text-muted); | |
| 242 | font-size: 13px; | |
| 243 | line-height: 1.55; | |
| 244 | } | |
| 245 | `; | |
| 246 | ||
| 80bed05 | 247 | help.get("/help", (c) => { |
| 248 | const user = c.get("user"); | |
| 249 | ||
| 250 | return c.html( | |
| 251 | <Layout title="Help — gluecron" user={user}> | |
| bdb51e4 | 252 | <style dangerouslySetInnerHTML={{ __html: helpStyles }} /> |
| 253 | <div class="help-wrap"> | |
| 254 | {/* ─── Hero ─── */} | |
| 255 | <header class="help-hero"> | |
| 256 | <div class="help-hero-bg" aria-hidden="true"> | |
| 257 | <div class="help-hero-orb" /> | |
| 258 | </div> | |
| 259 | <div class="help-hero-inner"> | |
| 260 | <div class="help-hero-eyebrow"> | |
| 261 | <span class="help-hero-eyebrow-pill" aria-hidden="true">?</span> | |
| 262 | <span>Help & quickstart</span> | |
| 263 | </div> | |
| 264 | <h1 class="help-hero-title"> | |
| 265 | Ship onto{" "} | |
| 266 | <span class="help-gradient-text">gluecron</span> in five minutes. | |
| 267 | </h1> | |
| 268 | <p class="help-hero-sub"> | |
| 269 | Everything an owner migrating a product onto gluecron needs in one | |
| 270 | page. If something's unclear, open an issue — link at the bottom. | |
| 271 | </p> | |
| 272 | </div> | |
| 273 | </header> | |
| 80bed05 | 274 | |
| bdb51e4 | 275 | {/* ─── On this page ─── */} |
| 276 | <nav class="help-toc" aria-label="On this page"> | |
| 277 | <div class="help-toc-label">On this page</div> | |
| 278 | <div class="help-toc-list"> | |
| 279 | <a href="#getting-started">Getting started</a> | |
| 280 | <a href="#git-https">Git over HTTPS</a> | |
| 281 | <a href="#git-ssh">Git over SSH</a> | |
| 282 | <a href="#import">Importing from GitHub</a> | |
| 283 | <a href="#webhooks">Webhooks</a> | |
| 8809b87 | 284 | <a href="#chat-bots">Slack & Discord bots</a> |
| bdb51e4 | 285 | <a href="#tokens">Personal access tokens</a> |
| 286 | <a href="#gates">Gates & AI review</a> | |
| 287 | <a href="#ai-native">AI-native flow</a> | |
| c6018a5 | 288 | <a href="#ai-surfaces">New AI surfaces</a> |
| 289 | <a href="#repo-chat">Chat with a repo</a> | |
| 290 | <a href="#previews">Branch previews</a> | |
| 291 | <a href="#migrations">Migration assistant</a> | |
| 292 | <a href="#slash-commands">PR slash commands</a> | |
| 293 | <a href="#release-notes">AI release notes</a> | |
| 294 | <a href="#ai-commits">AI commit messages</a> | |
| 295 | <a href="#agents">Agent multiplayer</a> | |
| 296 | <a href="#semantic">Semantic search API</a> | |
| bdb51e4 | 297 | <a href="#shortcuts">Keyboard shortcuts</a> |
| 298 | <a href="#api">API</a> | |
| c6018a5 | 299 | <a href="#build-agents">Build-agent integration</a> |
| c4e643c | 300 | <a href="#self-host">Self-host (single binary)</a> |
| bdb51e4 | 301 | </div> |
| 80bed05 | 302 | </nav> |
| 303 | ||
| bdb51e4 | 304 | {/* ─── Getting started ─── */} |
| 305 | <section id="getting-started" class="help-section"> | |
| 306 | <div class="help-section-head"> | |
| 307 | <div class="help-section-eyebrow">Step 01</div> | |
| 308 | <h2 class="help-section-title">Getting started</h2> | |
| 309 | <p class="help-section-desc"> | |
| 310 | Register, verify, and create your first repo. | |
| 311 | </p> | |
| 312 | </div> | |
| 313 | <div class="help-section-body"> | |
| 314 | <div class="help-item"> | |
| 315 | <strong>1. Register an account.</strong>{" "} | |
| 316 | Head to <a href="/register">/register</a>, pick a username, and | |
| 317 | set a password. Usernames are your public handle and appear in | |
| 318 | every repo URL. | |
| 80bed05 | 319 | </div> |
| bdb51e4 | 320 | <div class="help-item"> |
| 321 | <strong>2. Verify your email.</strong>{" "} | |
| 322 | We send a one-time link the first time you sign in. Verified | |
| 323 | addresses can receive issue, PR, and gate-run notifications. | |
| 80bed05 | 324 | </div> |
| bdb51e4 | 325 | <div class="help-item"> |
| 326 | <strong>3. Create your first repo.</strong>{" "} | |
| 327 | From the dashboard hit <strong>New repository</strong>, or | |
| 328 | visit <a href="/new">/new</a>. Pick public or private, add a | |
| 329 | README, and you're ready to clone. | |
| 80bed05 | 330 | </div> |
| 331 | </div> | |
| 332 | </section> | |
| 333 | ||
| bdb51e4 | 334 | {/* ─── Git over HTTPS ─── */} |
| 335 | <section id="git-https" class="help-section"> | |
| 336 | <div class="help-section-head"> | |
| 337 | <div class="help-section-eyebrow">Protocol</div> | |
| 338 | <h2 class="help-section-title">Git over HTTPS</h2> | |
| 339 | <p class="help-section-desc"> | |
| 340 | HTTPS works out of the box. Authenticate with your account | |
| 341 | password or, better, a personal access token. | |
| 342 | </p> | |
| 343 | </div> | |
| 344 | <div class="help-section-body"> | |
| 345 | <div class="help-item"> | |
| 346 | <strong>Clone</strong> | |
| 347 | <pre class="help-code"> | |
| 80bed05 | 348 | {`git clone https://<your-host>/<owner>/<repo>.git`} |
| bdb51e4 | 349 | </pre> |
| 80bed05 | 350 | </div> |
| bdb51e4 | 351 | <div class="help-item"> |
| 352 | <strong>Push</strong> | |
| 353 | <pre class="help-code"> | |
| 80bed05 | 354 | {`git push origin main`} |
| bdb51e4 | 355 | </pre> |
| 80bed05 | 356 | </div> |
| bdb51e4 | 357 | <div class="help-item"> |
| 358 | <strong>Pull</strong> | |
| 359 | <pre class="help-code"> | |
| 80bed05 | 360 | {`git pull origin main`} |
| bdb51e4 | 361 | </pre> |
| 80bed05 | 362 | </div> |
| 363 | </div> | |
| 364 | </section> | |
| 365 | ||
| bdb51e4 | 366 | {/* ─── Git over SSH ─── */} |
| 367 | <section id="git-ssh" class="help-section"> | |
| 368 | <div class="help-section-head"> | |
| 369 | <div class="help-section-eyebrow">Protocol</div> | |
| 370 | <h2 class="help-section-title">Git over SSH</h2> | |
| 371 | <p class="help-section-desc"> | |
| 372 | SSH avoids typing credentials and is recommended for day-to-day | |
| 373 | work. | |
| 374 | </p> | |
| 375 | </div> | |
| 376 | <div class="help-section-body"> | |
| 377 | <div class="help-item"> | |
| 378 | <strong>1. Add your key.</strong>{" "} | |
| 379 | Copy your public key (usually{" "} | |
| 380 | <code>~/.ssh/id_ed25519.pub</code>) and paste it into{" "} | |
| 381 | <a href="/settings/keys">/settings/keys</a>. Keys take effect | |
| 382 | immediately. | |
| 80bed05 | 383 | </div> |
| bdb51e4 | 384 | <div class="help-item"> |
| 385 | <strong>2. Clone using the SSH URL.</strong> | |
| 386 | <pre class="help-code"> | |
| 80bed05 | 387 | {`git clone git@<your-host>:<owner>/<repo>.git`} |
| bdb51e4 | 388 | </pre> |
| 80bed05 | 389 | </div> |
| bdb51e4 | 390 | <div class="help-item"> |
| 391 | <strong>3. Rotate or revoke</strong> any key from the same | |
| 392 | settings page — useful when a laptop walks off. | |
| 80bed05 | 393 | </div> |
| 394 | </div> | |
| 395 | </section> | |
| 396 | ||
| bdb51e4 | 397 | {/* ─── Import ─── */} |
| 398 | <section id="import" class="help-section"> | |
| 399 | <div class="help-section-head"> | |
| 400 | <div class="help-section-eyebrow">Migration</div> | |
| 401 | <h2 class="help-section-title">Importing from GitHub</h2> | |
| 402 | <p class="help-section-desc"> | |
| 403 | One-time mirror with full history, branches, and tags. | |
| 404 | </p> | |
| 405 | </div> | |
| 406 | <div class="help-section-body"> | |
| 407 | <div class="help-item"> | |
| 408 | Visit <a href="/import">/import</a>, paste the source URL, and | |
| 409 | gluecron will mirror the repository — full history, branches, | |
| 410 | and tags. The mirror is a one-time copy; subsequent pushes | |
| 411 | land on gluecron, not the source. Private sources need a PAT | |
| 412 | on the source side. | |
| 80bed05 | 413 | </div> |
| 414 | </div> | |
| 415 | </section> | |
| 416 | ||
| bdb51e4 | 417 | {/* ─── Webhooks ─── */} |
| 418 | <section id="webhooks" class="help-section"> | |
| 419 | <div class="help-section-head"> | |
| 420 | <div class="help-section-eyebrow">Integrations</div> | |
| 421 | <h2 class="help-section-title">Webhooks</h2> | |
| 422 | <p class="help-section-desc"> | |
| 423 | Per-repo webhooks live at{" "} | |
| 424 | <code>/:owner/:repo/settings/webhooks</code>. Register a URL, pick | |
| 425 | events (push, issue, pr, star), and set a secret. | |
| 426 | </p> | |
| 427 | </div> | |
| 428 | <div class="help-section-body"> | |
| 429 | <div class="help-item"> | |
| 430 | <strong>HMAC signature.</strong>{" "} | |
| 431 | Every delivery includes{" "} | |
| 432 | <code>X-Gluecron-Signature: sha256=<hex></code>.{" "} | |
| 433 | Compute HMAC-SHA256 over the raw request body using your | |
| 434 | secret and compare in constant time. | |
| 80bed05 | 435 | </div> |
| bdb51e4 | 436 | <div class="help-item"> |
| 437 | <strong>Payload shape.</strong> | |
| 438 | <pre class="help-code"> | |
| 80bed05 | 439 | {`{ |
| 440 | "event": "push", | |
| 441 | "repo": { "owner": "acme", "name": "api" }, | |
| 442 | "ref": "refs/heads/main", | |
| 443 | "before": "<sha>", | |
| 444 | "after": "<sha>", | |
| 445 | "commits": [ /* ... */ ], | |
| 446 | "sender": { "username": "kit" } | |
| 447 | }`} | |
| bdb51e4 | 448 | </pre> |
| 80bed05 | 449 | </div> |
| bdb51e4 | 450 | <div class="help-item"> |
| 451 | Deliveries are retried with exponential backoff; inspect the | |
| 452 | last N attempts from the webhook's settings page. | |
| 80bed05 | 453 | </div> |
| 454 | </div> | |
| 455 | </section> | |
| 456 | ||
| 8809b87 | 457 | {/* ─── Slack + Discord bots ─── */} |
| 458 | <section id="chat-bots" class="help-section"> | |
| 459 | <div class="help-section-head"> | |
| 460 | <div class="help-section-eyebrow">Integrations</div> | |
| 461 | <h2 class="help-section-title">Slack & Discord</h2> | |
| 462 | <p class="help-section-desc"> | |
| 463 | Install the Gluecron bot from{" "} | |
| 464 | <a href="/settings/integrations">/settings/integrations</a>{" "} | |
| 465 | to drive your repos from chat. PR opens, merges, and AI | |
| 466 | review summaries also push back into the channel. | |
| 467 | </p> | |
| 468 | </div> | |
| 469 | <div class="help-section-body"> | |
| 470 | <div class="help-item"> | |
| 471 | <strong>Slash commands.</strong> | |
| 472 | <pre class="help-code"> | |
| 473 | {`/gluecron pr list owner/repo | |
| 474 | /gluecron pr open owner/repo "Add dark mode" | |
| 475 | /gluecron issue list owner/repo | |
| 476 | /gluecron issue create owner/repo "Bug in foo()" | |
| 477 | /gluecron spec ship "rewrite the cron scheduler" | |
| 478 | /gluecron chat "How do I run the tests?" | |
| 479 | /gluecron help`} | |
| 480 | </pre> | |
| 481 | </div> | |
| 482 | <div class="help-item"> | |
| 483 | <strong>Signature verification.</strong> Slack requests are | |
| 484 | checked against your signing secret (HMAC-SHA256 over{" "} | |
| 485 | <code>v0:<timestamp>:<body></code>). Discord | |
| 486 | interactions are verified against your Application Public | |
| 487 | Key with Ed25519. Bad signatures get a 401. | |
| 488 | </div> | |
| 489 | <div class="help-item"> | |
| 490 | <strong>Outbound notifications.</strong> Once installed, PR | |
| 491 | opens / merges, issue creates, and AI review summaries | |
| 492 | auto-post to your channel. Disable on a per-workspace basis | |
| 493 | from <a href="/settings/integrations">/settings/integrations</a>. | |
| 494 | </div> | |
| 495 | </div> | |
| 496 | </section> | |
| 497 | ||
| bdb51e4 | 498 | {/* ─── Tokens ─── */} |
| 499 | <section id="tokens" class="help-section"> | |
| 500 | <div class="help-section-head"> | |
| 501 | <div class="help-section-eyebrow">Auth</div> | |
| 502 | <h2 class="help-section-title">Personal access tokens</h2> | |
| 503 | <p class="help-section-desc"> | |
| 504 | Tokens authenticate CLI clients, CI jobs, and scripts. Create | |
| 505 | them at <a href="/settings/tokens">/settings/tokens</a>; the value | |
| 506 | is shown once, so copy it immediately. Tokens start with{" "} | |
| 507 | <code>glc_</code>. | |
| 508 | </p> | |
| 509 | </div> | |
| 510 | <div class="help-section-body"> | |
| 511 | <div class="help-item"> | |
| 512 | <strong>Example: list your repos via the API.</strong> | |
| 513 | <pre class="help-code"> | |
| 80bed05 | 514 | {`curl -H "Authorization: Bearer glc_your_token_here" \\ |
| 515 | https://<your-host>/api/v2/repos`} | |
| bdb51e4 | 516 | </pre> |
| 80bed05 | 517 | </div> |
| bdb51e4 | 518 | <div class="help-item"> |
| 519 | Tokens can also authenticate <code>git</code> over HTTPS — use | |
| 520 | the token as the password in place of your account password. | |
| 80bed05 | 521 | </div> |
| 522 | </div> | |
| 523 | </section> | |
| 524 | ||
| bdb51e4 | 525 | {/* ─── Gates & AI review ─── */} |
| 526 | <section id="gates" class="help-section"> | |
| 527 | <div class="help-section-head"> | |
| 528 | <div class="help-section-eyebrow">Quality</div> | |
| 529 | <h2 class="help-section-title">Gates & AI review</h2> | |
| 530 | <p class="help-section-desc"> | |
| 531 | Push-time scanning + an AI pair reviewer on every PR. | |
| 532 | </p> | |
| 533 | </div> | |
| 534 | <div class="help-section-body"> | |
| 535 | <div class="help-item"> | |
| 536 | Every push to the default branch (usually <code>main</code>) | |
| 537 | triggers a gate run: GateTest scans the diff for secrets, | |
| 538 | dependency advisories, and policy violations, while the AI | |
| 539 | reviewer reads the patch and comments on any PRs that touch | |
| 540 | the same files. Failing gates block the push by default; | |
| 541 | results appear on the commit page and in the repo's{" "} | |
| 542 | <em>Gate runs</em> tab. Configure gate policy per-repo in | |
| 543 | <strong> Settings → Gates</strong>. | |
| 80bed05 | 544 | </div> |
| 545 | </div> | |
| 546 | </section> | |
| 547 | ||
| bdb51e4 | 548 | {/* ─── AI-native flow ─── */} |
| 549 | <section id="ai-native" class="help-section"> | |
| 550 | <div class="help-section-head"> | |
| 551 | <div class="help-section-eyebrow">AI-native</div> | |
| 552 | <h2 class="help-section-title">AI-native flow</h2> | |
| 553 | <p class="help-section-desc"> | |
| 554 | Surfaces that ride on <code>ANTHROPIC_API_KEY</code>, with | |
| 555 | deterministic fallbacks when it's missing. | |
| 556 | </p> | |
| 557 | </div> | |
| 558 | <div class="help-section-body"> | |
| 559 | <div class="help-item"> | |
| 560 | <strong>Issue → PR in one click.</strong> Open any issue you | |
| 561 | own and hit <em>Build with AI</em> in the header. The spec | |
| 562 | form pre-fills with the issue title + body and a{" "} | |
| 563 | <code>Closes #N</code> footer; Claude drafts the diff, opens | |
| 564 | a draft PR, and the merge auto-closes the originating issue. | |
| 2afb411 | 565 | </div> |
| bdb51e4 | 566 | <div class="help-item"> |
| 567 | <strong>AI-drafted PR descriptions.</strong> The new-PR form | |
| 568 | has a <em>Suggest description with AI</em> button that runs | |
| 569 | <code> generatePrSummary</code> against{" "} | |
| 570 | <code>git diff base...head</code> and fills the description | |
| 571 | with a structured summary (Why · Key changes · Test plan · | |
| 572 | Risks). | |
| 2afb411 | 573 | </div> |
| bdb51e4 | 574 | <div class="help-item"> |
| 575 | <strong>Auto-review on PR open.</strong> Non-draft PRs get a | |
| 576 | summary comment plus inline file/line annotations from the | |
| 577 | AI reviewer. A second comment posts label + reviewer + | |
| 578 | priority suggestions (the <em>AI Triage</em> block). All | |
| 579 | suggestions; nothing applied automatically. | |
| 2afb411 | 580 | </div> |
| bdb51e4 | 581 | <div class="help-item"> |
| 582 | <strong>Repo-wide AI surfaces.</strong>{" "} | |
| 583 | <a href="/help#explore">Explain</a> a codebase, run{" "} | |
| 584 | <a href="/help#explore">semantic search</a>, ask the chat | |
| 585 | anything about the repo, generate failing test stubs from a | |
| 586 | source file (the <em>Tests</em> link in the repo nav), and | |
| 587 | draft full PRs from a plain-English spec via{" "} | |
| 588 | <em>Spec to PR</em>. All require{" "} | |
| 589 | <code>ANTHROPIC_API_KEY</code>; without it the surfaces | |
| 590 | degrade gracefully to deterministic fallbacks. | |
| 2afb411 | 591 | </div> |
| bdb51e4 | 592 | <div class="help-item"> |
| 593 | <strong>Scheduled workflows.</strong> Drop{" "} | |
| 594 | <code>on: schedule: [{`{cron: "0 * * * *"}`}]</code> into any | |
| 595 | <code> .gluecron/workflows/*.yml</code>. The autopilot | |
| 596 | ticker fires the cron from the same node that handles your | |
| 597 | pushes — no external scheduler needed. | |
| 2afb411 | 598 | </div> |
| 599 | </div> | |
| 600 | </section> | |
| 601 | ||
| c6018a5 | 602 | {/* ─── New AI surfaces (global) ─── */} |
| 603 | <section id="ai-surfaces" class="help-section"> | |
| 604 | <div class="help-section-head"> | |
| 605 | <div class="help-section-eyebrow">Discover</div> | |
| 606 | <h2 class="help-section-title">New AI surfaces</h2> | |
| 607 | <p class="help-section-desc"> | |
| 608 | Seven cross-repo dashboards that ship with Gluecron — find | |
| 609 | them under the <strong>AI</strong> dropdown in the top nav, | |
| 610 | plus the always-on <em>Pulls</em>, <em>Issues</em>,{" "} | |
| 611 | <em>Activity</em>, and <em>Inbox</em> tabs. | |
| 612 | </p> | |
| 613 | </div> | |
| 614 | <div class="help-section-body"> | |
| 615 | <div class="help-item"> | |
| 616 | <strong><a href="/pulls">/pulls</a> — global pull-request | |
| 617 | dashboard.</strong> Every open PR across every repo you own | |
| 618 | or follow, grouped by review state. Filter by author, label, | |
| 619 | or repo. Replaces tab-flicking between repos when you just | |
| 620 | want to know "what needs me right now." | |
| 621 | </div> | |
| 622 | <div class="help-item"> | |
| 623 | <strong><a href="/issues">/issues</a> — global issue | |
| 624 | dashboard.</strong> Same shape as <code>/pulls</code> for | |
| 625 | issues. Combine the <code>ai:build</code> filter with{" "} | |
| 626 | <em>assigned to me</em> to scan everything Claude is queued | |
| 627 | to build for you. | |
| 628 | </div> | |
| 629 | <div class="help-item"> | |
| 630 | <strong><a href="/inbox">/inbox</a> — unified inbox.</strong>{" "} | |
| 631 | Mentions, review requests, CI failures, and AI-generated | |
| 632 | actions in one stream. Filters at the top:{" "} | |
| 633 | <code>filter=mentions</code>, <code>filter=review</code>,{" "} | |
| 634 | <code>filter=ci</code>, <code>filter=ai</code>. The badge | |
| 635 | count next to <em>Inbox</em> in the nav is unread items. | |
| 636 | </div> | |
| 637 | <div class="help-item"> | |
| 638 | <strong><a href="/activity">/activity</a> — your | |
| 639 | timeline.</strong> A chronological feed of every push, | |
| 640 | merge, comment, and AI action across your repos. Useful for | |
| 641 | writing your own weekly recap and for spotting when an | |
| 642 | autopilot task fired without you noticing. | |
| 643 | </div> | |
| 644 | <div class="help-item"> | |
| 645 | <strong><a href="/standups">/standups</a> — daily AI | |
| 646 | brief.</strong> Claude writes a short standup at your | |
| 647 | configured time (defaults to 09:00 UTC) summarising | |
| 648 | yesterday's pushes, today's open PRs, and anything blocking. | |
| 649 | Toggle the cadence in <a href="/settings">Settings → | |
| 650 | Standups</a>. Hit <em>Refresh</em> on the page to regenerate | |
| 651 | for the current window. | |
| 652 | </div> | |
| 653 | <div class="help-item"> | |
| 654 | <strong><a href="/voice">/voice</a> — voice-to-PR.</strong>{" "} | |
| 655 | Hit record, speak a feature spec, stop — Claude transcribes, | |
| 656 | picks the target repo, drafts the diff, and opens a draft | |
| 657 | PR. The whole loop fits in a single browser tab; no native | |
| 658 | app, no Whisper setup. Uses the browser's MediaRecorder API | |
| 659 | under the hood — Chrome, Safari 17+, Firefox. | |
| 660 | </div> | |
| 661 | <div class="help-item"> | |
| 662 | <strong><a href="/refactors">/refactors</a> — multi-repo | |
| 663 | refactor agent.</strong> Paste a brief like "rename the{" "} | |
| 664 | <code>cents</code> field to <code>amountMinor</code> across | |
| 665 | every API repo." Claude walks each repo, generates a patch, | |
| 666 | and opens a draft PR per repo. Tracking dashboard shows | |
| 667 | per-repo status (drafted / pushed / merged / failed). | |
| 668 | </div> | |
| 669 | <div class="help-item"> | |
| 670 | <strong><a href="/specs">/specs</a> — spec-to-PR loop.</strong> | |
| 671 | Every <code>.gluecron/specs/*.md</code> file across your | |
| 672 | repos shows up here. Add a spec, push it, then either run | |
| 673 | the spec-to-PR generator from the page or label the file | |
| 674 | and let autopilot do it overnight. | |
| 675 | </div> | |
| 676 | </div> | |
| 677 | </section> | |
| 678 | ||
| 679 | {/* ─── Chat with a repo ─── */} | |
| 680 | <section id="repo-chat" class="help-section"> | |
| 681 | <div class="help-section-head"> | |
| 682 | <div class="help-section-eyebrow">Per-repo</div> | |
| 683 | <h2 class="help-section-title">Chat with a repo</h2> | |
| 684 | <p class="help-section-desc"> | |
| 685 | Rubber-duck a question against any single repo. Powered by | |
| 686 | the semantic code index — Claude pulls the relevant files | |
| 687 | on every turn so answers stay grounded in your actual code. | |
| 688 | </p> | |
| 689 | </div> | |
| 690 | <div class="help-section-body"> | |
| 691 | <div class="help-item"> | |
| 692 | Visit <code>/:owner/:repo/chat</code> on any repo you can | |
| 693 | read (the dashboard <em>Quick actions</em> panel has a | |
| 694 | one-click link). Ask "where does auth happen?", "what does | |
| 695 | this Drizzle migration do?", "draft a test for {`<file>`}". | |
| 696 | The chat scrolls forever and the context is freshly retrieved | |
| 697 | on every message — so file moves and recent pushes are | |
| 698 | immediately visible to Claude. | |
| 699 | </div> | |
| 700 | <div class="help-item"> | |
| 701 | <strong>Foundation: semantic search.</strong>{" "} | |
| 702 | <code>/:owner/:repo/semantic-search?q=…</code> is the | |
| 703 | underlying retrieval. Chunks are embedded with{" "} | |
| 704 | <code>voyage-code-3</code> when <code>VOYAGE_API_KEY</code>{" "} | |
| 705 | is set; otherwise a lexical fallback (still useful — same | |
| 706 | chunking and ranking, just no embeddings). | |
| 707 | </div> | |
| 708 | </div> | |
| 709 | </section> | |
| 710 | ||
| 711 | {/* ─── Branch previews ─── */} | |
| 712 | <section id="previews" class="help-section"> | |
| 713 | <div class="help-section-head"> | |
| 714 | <div class="help-section-eyebrow">Per-repo</div> | |
| 715 | <h2 class="help-section-title">Branch previews</h2> | |
| 716 | <p class="help-section-desc"> | |
| 717 | Every non-default branch with a Dockerfile or a{" "} | |
| 718 | <code>.gluecron/preview.yml</code> gets an ephemeral preview | |
| 719 | URL. Spin up, share, tear down — automatically on push. | |
| 720 | </p> | |
| 721 | </div> | |
| 722 | <div class="help-section-body"> | |
| 723 | <div class="help-item"> | |
| 724 | Open <code>/:owner/:repo/previews</code> to see the list of | |
| 725 | live previews for the repo. Each row shows the branch, the | |
| 726 | last commit, the preview URL, and the most recent build log. | |
| 727 | Previews self-destruct when the branch is deleted or merged. | |
| 728 | </div> | |
| 729 | <div class="help-item"> | |
| 730 | <strong>Linked from PRs.</strong> Whenever a PR is opened | |
| 731 | against the default branch, the PR header surfaces the | |
| 732 | preview URL so reviewers click straight through to a running | |
| 733 | instance instead of pulling locally. | |
| 734 | </div> | |
| 735 | </div> | |
| 736 | </section> | |
| 737 | ||
| 79ed944 | 738 | {/* ─── PR sandboxes (migration 0067) ─── */} |
| 739 | <section id="pr-sandboxes" class="help-section"> | |
| 740 | <div class="help-section-head"> | |
| 741 | <div class="help-section-eyebrow">Per-PR</div> | |
| 742 | <h2 class="help-section-title">Runnable PR sandboxes</h2> | |
| 743 | <p class="help-section-desc"> | |
| 744 | Every PR can spin up a live, executable sandbox at{" "} | |
| 745 | <code>pr-N-owner-repo.sandbox.gluecron.com</code>. | |
| 746 | Reviewers click "Try this PR live" and poke the change in | |
| 747 | a real browser before merging. Auto-destroys after 4h. | |
| 748 | </p> | |
| 749 | </div> | |
| 750 | <div class="help-section-body"> | |
| 751 | <div class="help-item"> | |
| 752 | <strong>Opt-in defaults.</strong> Per-PR sandboxes are | |
| 753 | triggered manually from the PR detail page; flip{" "} | |
| 754 | <code>auto_pr_sandbox</code> on in repo settings to make | |
| 755 | every newly opened PR provision one automatically. | |
| 756 | </div> | |
| 757 | <div class="help-item"> | |
| 758 | <strong>Customise via <code>.gluecron/playground.yml</code>.</strong>{" "} | |
| 759 | Commit this file at the repo root to control what the | |
| 760 | sandbox runs. If it's missing, Claude drafts one from your | |
| 761 | repo on first provision. | |
| 762 | <pre class="help-code"> | |
| 763 | {`# .gluecron/playground.yml | |
| 764 | runtime: docker | |
| 765 | image: node:20-alpine | |
| 766 | ports: [3000] | |
| 767 | seed: | |
| 768 | - "npm install" | |
| 769 | - "node scripts/seed-demo.js" | |
| 770 | command: "npm start" | |
| 771 | env: | |
| 772 | NODE_ENV: development`} | |
| 773 | </pre> | |
| 774 | </div> | |
| 775 | <div class="help-item"> | |
| 776 | <strong>API.</strong> Poll{" "} | |
| 777 | <code>GET /:owner/:repo/pulls/:n/sandbox</code> for the | |
| 778 | status JSON. <code>POST .../sandbox/provision</code> and{" "} | |
| 779 | <code>POST .../sandbox/destroy</code> drive the lifecycle. | |
| 780 | Sandboxes are deterministic by PR number, so the URL is | |
| 781 | stable across re-provisions. | |
| 782 | </div> | |
| 783 | </div> | |
| 784 | </section> | |
| 785 | ||
| 9b3a183 | 786 | {/* ─── Cloud dev environments (migration 0072) ─── */} |
| 787 | <section id="dev-envs" class="help-section"> | |
| 788 | <div class="help-section-eyebrow">Per-repo</div> | |
| 789 | <h2 class="help-section-title">Cloud dev environments</h2> | |
| 790 | <p class="help-section-desc"> | |
| 791 | Hit <code>/:owner/:repo/dev</code> to get a hosted VS Code IDE | |
| 792 | in your browser, backed by a cold-start container. One env per | |
| 793 | (repo, user); idle envs stop themselves after{" "} | |
| 794 | <strong>30 minutes</strong> so we don't leak compute. | |
| 795 | Customise per-repo via <code>.gluecron/dev.yml</code>. | |
| 796 | </p> | |
| 797 | <div class="help-section-body"> | |
| 798 | <div class="help-item"> | |
| 799 | <strong>Opt-in defaults.</strong> Cloud dev environments are | |
| 800 | off by default. Flip the toggle in repo settings under{" "} | |
| 801 | <code>Settings → Dev environments</code> to surface the route | |
| 802 | on your repo. | |
| 803 | </div> | |
| 804 | <div class="help-item"> | |
| 805 | <strong>Customise via <code>.gluecron/dev.yml</code>.</strong>{" "} | |
| 806 | Commit this file at the repo root to control what your dev | |
| 807 | env runs. If it's missing, Claude drafts one from your | |
| 808 | repo on first start. | |
| 809 | <pre class="help-code"> | |
| 810 | {`# .gluecron/dev.yml — Node example | |
| 811 | image: node:20-alpine | |
| 812 | ports: [3000] | |
| 813 | install: | |
| 814 | - npm install | |
| 815 | postCreate: | |
| 816 | - npm run db:seed | |
| 817 | command: npm run dev | |
| 818 | recommendedExtensions: | |
| 819 | - dbaeumer.vscode-eslint | |
| 820 | - esbenp.prettier-vscode`} | |
| 821 | </pre> | |
| 822 | <pre class="help-code"> | |
| 823 | {`# .gluecron/dev.yml — Python example | |
| 824 | image: python:3.12-slim | |
| 825 | ports: [8000] | |
| 826 | install: | |
| 827 | - pip install -r requirements.txt | |
| 828 | postCreate: | |
| 829 | - python manage.py migrate | |
| 830 | command: python manage.py runserver 0.0.0.0:8000 | |
| 831 | recommendedExtensions: | |
| 832 | - ms-python.python | |
| 833 | - ms-python.vscode-pylance`} | |
| 834 | </pre> | |
| 835 | <pre class="help-code"> | |
| 836 | {`# .gluecron/dev.yml — Rust example | |
| 837 | image: rust:1.78 | |
| 838 | ports: [8080] | |
| 839 | install: | |
| 840 | - cargo fetch | |
| 841 | postCreate: [] | |
| 842 | command: cargo run | |
| 843 | recommendedExtensions: | |
| 844 | - rust-lang.rust-analyzer | |
| 845 | - vadimcn.vscode-lldb`} | |
| 846 | </pre> | |
| 847 | </div> | |
| 848 | <div class="help-item"> | |
| 849 | <strong>API.</strong>{" "} | |
| 850 | <code>POST /api/v2/repos/:owner/:repo/dev/start</code>{" "} | |
| 851 | provisions (or warms-up) an env;{" "} | |
| 852 | <code>POST /api/v2/repos/:owner/:repo/dev/stop</code>{" "} | |
| 853 | gracefully stops one; and{" "} | |
| 854 | <code>GET /api/v2/repos/:owner/:repo/dev/status</code>{" "} | |
| 855 | returns the JSON shape used by the in-page poller. | |
| 856 | </div> | |
| 857 | <div class="help-item"> | |
| 858 | <strong>Idle sweep.</strong> The{" "} | |
| 859 | <code>dev-env-idle-sweep</code> autopilot task runs every | |
| 860 | 5 minutes and stops any env whose{" "} | |
| 861 | <code>last_active_at + idle_minutes</code> has passed. Each | |
| 862 | page hit bumps <code>last_active_at</code> so an open IDE | |
| 863 | tab keeps the env warm. | |
| 864 | </div> | |
| 865 | </div> | |
| 866 | </section> | |
| 867 | ||
| c6018a5 | 868 | {/* ─── Migration assistant ─── */} |
| 869 | <section id="migrations" class="help-section"> | |
| 870 | <div class="help-section-head"> | |
| 871 | <div class="help-section-eyebrow">Per-repo</div> | |
| 872 | <h2 class="help-section-title">Migration assistant</h2> | |
| 873 | <p class="help-section-desc"> | |
| 874 | When you touch a Drizzle schema, Claude proposes the | |
| 875 | corresponding migration SQL and a one-line rollback plan. | |
| 876 | No more "did I forget the migration?" PRs. | |
| 877 | </p> | |
| 878 | </div> | |
| 879 | <div class="help-section-body"> | |
| 880 | <div class="help-item"> | |
| 881 | Visit <code>/:owner/:repo/migrations/propose</code> and | |
| 882 | point the assistant at a recent schema change. It returns | |
| 883 | the SQL diff, an up/down script, and a checklist of edge | |
| 884 | cases (NULL→NOT NULL, type widening, default backfill). Save | |
| 885 | the suggestion straight into <code>drizzle/NNNN_*.sql</code>{" "} | |
| 886 | when you're happy with it. | |
| 887 | </div> | |
| 888 | <div class="help-item"> | |
| 889 | <strong>Discoverability.</strong> Surfaced from{" "} | |
| 890 | <code>Settings → Integrations</code> on the repo, and | |
| 891 | auto-pinged when a push modifies <code>src/db/schema.ts</code>{" "} | |
| 892 | without a sibling migration file. | |
| 893 | </div> | |
| 894 | </div> | |
| 895 | </section> | |
| 896 | ||
| 897 | {/* ─── PR slash commands ─── */} | |
| 898 | <section id="slash-commands" class="help-section"> | |
| 899 | <div class="help-section-head"> | |
| 900 | <div class="help-section-eyebrow">PR power</div> | |
| 901 | <h2 class="help-section-title">PR slash commands</h2> | |
| 902 | <p class="help-section-desc"> | |
| 903 | Type <code>/</code> at the start of a PR comment to invoke | |
| 904 | Claude inline. The composer hint shows the list as you type. | |
| 905 | </p> | |
| 906 | </div> | |
| 907 | <div class="help-section-body"> | |
| 908 | <div class="help-item"> | |
| 909 | <strong>Available commands.</strong> | |
| 910 | <pre class="help-code"> | |
| 911 | {`/review Re-run the AI reviewer on the latest diff | |
| 912 | /summarise Drop a fresh PR summary into the description | |
| 913 | /test-plan Generate a test plan from the diff | |
| 914 | /explain-this Plain-English summary of one file or hunk | |
| 915 | /risk Score the diff for breaking-change risk | |
| 916 | /migrate Propose a Drizzle migration for schema changes | |
| 917 | /release-notes Draft release notes covering this PR only | |
| 918 | /help List every command`} | |
| 919 | </pre> | |
| 920 | </div> | |
| 921 | <div class="help-item"> | |
| 922 | Commands are deterministic when <code>ANTHROPIC_API_KEY</code>{" "} | |
| 923 | is missing (fallbacks summarise file lists; no model output). | |
| 924 | They also work from the CLI: <code>gluecron pr cmd /review</code>. | |
| 925 | </div> | |
| 926 | </div> | |
| 927 | </section> | |
| 928 | ||
| 929 | {/* ─── AI release notes ─── */} | |
| 930 | <section id="release-notes" class="help-section"> | |
| 931 | <div class="help-section-head"> | |
| 932 | <div class="help-section-eyebrow">Releases</div> | |
| 933 | <h2 class="help-section-title">AI release notes</h2> | |
| 934 | <p class="help-section-desc"> | |
| 935 | The release form has a <em>Generate notes</em> button that | |
| 936 | drafts a polished changelog from every PR merged since the | |
| 937 | previous tag. | |
| 938 | </p> | |
| 939 | </div> | |
| 940 | <div class="help-section-body"> | |
| 941 | <div class="help-item"> | |
| 942 | From <code>/:owner/:repo/releases/new</code>, type a new tag | |
| 943 | name and click <em>Generate notes</em>. Claude calls{" "} | |
| 944 | <code>POST /api/v2/repos/:owner/:repo/releases/notes</code>{" "} | |
| 945 | with the from/to tags and returns markdown grouped by{" "} | |
| 946 | <em>Features</em>, <em>Fixes</em>, <em>Internal</em>. Edit | |
| 947 | before publishing or accept as-is. | |
| 948 | </div> | |
| 949 | </div> | |
| 950 | </section> | |
| 951 | ||
| 952 | {/* ─── Agent multiplayer ─── */} | |
| 953 | <section id="agents" class="help-section"> | |
| 954 | <div class="help-section-head"> | |
| 955 | <div class="help-section-eyebrow">Multi-agent</div> | |
| 956 | <h2 class="help-section-title">Agent multiplayer</h2> | |
| 957 | <p class="help-section-desc"> | |
| 958 | Mint scoped tokens for AI agents, give each its own branch | |
| 959 | namespace + daily budget, and let them coordinate through | |
| 960 | the lease API so two Claudes never touch the same file. | |
| 961 | </p> | |
| 962 | </div> | |
| 963 | <div class="help-section-body"> | |
| 964 | <div class="help-item"> | |
| 965 | <strong>Manage agents</strong> at{" "} | |
| 966 | <a href="/settings/agents">/settings/agents</a>. Each agent | |
| 967 | gets a name, a branch namespace | |
| 968 | (<code>refs/heads/<namespace>*</code>), and a daily | |
| 969 | spend cap. Tokens are shown once on creation — copy them | |
| 970 | immediately. The same page lists the most recent leases | |
| 971 | (work-in-progress markers) per agent. | |
| 972 | </div> | |
| 973 | <div class="help-item"> | |
| 974 | <strong>Lease API.</strong>{" "} | |
| 975 | <code>POST /api/v2/agents/leases</code> acquires a lease on | |
| 976 | an issue, PR, or file path. Agents see currently-held | |
| 977 | leases via <code>GET /api/v2/agents/leases</code> and back | |
| 978 | off when a conflict is hit. Full protocol is in{" "} | |
| 979 | <code>docs/multiplayer.md</code> on the gluecron source repo. | |
| 980 | </div> | |
| 981 | </div> | |
| 982 | </section> | |
| 983 | ||
| 984 | {/* ─── Semantic search API ─── */} | |
| 985 | <section id="semantic" class="help-section"> | |
| 986 | <div class="help-section-head"> | |
| 987 | <div class="help-section-eyebrow">API</div> | |
| 988 | <h2 class="help-section-title">Semantic search API</h2> | |
| 989 | <p class="help-section-desc"> | |
| 990 | The same index that powers <em>Chat with a repo</em> is | |
| 991 | available as a JSON endpoint. | |
| 992 | </p> | |
| 993 | </div> | |
| 994 | <div class="help-section-body"> | |
| 995 | <div class="help-item"> | |
| 996 | <pre class="help-code"> | |
| 997 | {`curl -H "Authorization: Bearer glc_…" \\ | |
| 998 | "https://<your-host>/api/v2/repos/<owner>/<repo>/semantic-search?q=password+hashing&limit=10"`} | |
| 999 | </pre> | |
| 1000 | Returns a JSON array of <code>{`{ path, startLine, endLine, snippet, score }`}</code>{" "} | |
| 1001 | objects sorted by relevance. When <code>VOYAGE_API_KEY</code>{" "} | |
| 1002 | is unset on the server the endpoint falls back to lexical | |
| 1003 | ranking — useful for offline / air-gapped installs. | |
| 1004 | </div> | |
| 1005 | </div> | |
| 1006 | </section> | |
| 1007 | ||
| 9018b1f | 1008 | {/* ─── Setup AI commits ─── */} |
| 1009 | <section id="ai-commits" class="help-section"> | |
| 1010 | <div class="help-section-head"> | |
| 1011 | <div class="help-section-eyebrow">CLI</div> | |
| 1012 | <h2 class="help-section-title">Setup AI commits</h2> | |
| 1013 | <p class="help-section-desc"> | |
| 1014 | Let Claude write your commit messages. Two ways in: an | |
| 1015 | explicit <code>gluecron commit</code> wrapper, or a git | |
| 1016 | hook that fires whenever <code>git commit</code> runs | |
| 1017 | without <code>-m</code>. | |
| 1018 | </p> | |
| 1019 | </div> | |
| 1020 | <div class="help-section-body"> | |
| 1021 | <div class="help-item"> | |
| 1022 | <strong>1. Install the CLI.</strong> Grab a personal | |
| 1023 | access token from{" "} | |
| 1024 | <a href="/settings/tokens">/settings/tokens</a>, then: | |
| 1025 | <pre class="help-code"> | |
| 1026 | {`bun build --compile --outfile gluecron cli/gluecron.ts | |
| 1027 | sudo mv gluecron /usr/local/bin/ | |
| 1028 | gluecron login # paste the token`} | |
| 1029 | </pre> | |
| 1030 | </div> | |
| 1031 | <div class="help-item"> | |
| 1032 | <strong>2. Use <code>gluecron commit</code>.</strong>{" "} | |
| 1033 | Stage your changes the usual way, then: | |
| 1034 | <pre class="help-code"> | |
| 1035 | {`gluecron commit # AI drafts → [y]es / [e]dit / [n]o | |
| 1036 | gluecron commit -a # same, but stages tracked changes first | |
| 1037 | gluecron commit -m "..." # plain pass-through, no AI`} | |
| 1038 | </pre> | |
| 1039 | The draft is a Conventional Commit by default | |
| 1040 | (<code>feat(scope): subject</code> + body explaining why). | |
| 1041 | Pass <code>--plain</code> for a plain-English subject. | |
| 1042 | </div> | |
| 1043 | <div class="help-item"> | |
| 1044 | <strong>3. Or: install the git hook.</strong> One-time | |
| 1045 | setup; every plain <code>git commit</code> (no <code>-m</code>) | |
| 1046 | gets a draft pre-filled into the editor. | |
| 1047 | <pre class="help-code"> | |
| 1048 | {`cd /path/to/your/repo | |
| 1049 | gluecron hook install commit-msg | |
| 1050 | # undo: | |
| 1051 | gluecron hook uninstall commit-msg`} | |
| 1052 | </pre> | |
| 1053 | The hook only fires when the message is empty — explicit | |
| 1054 | <code> -m</code>, <code>--amend</code>, and merge commits | |
| 1055 | are left untouched. | |
| 1056 | </div> | |
| 1057 | <div class="help-item"> | |
| 1058 | All AI calls hit <code>POST /api/v2/ai/commit-message</code>, | |
| 1059 | rate-limited to <strong>60 requests/minute per token</strong>. | |
| 1060 | If <code>ANTHROPIC_API_KEY</code> is unset on the server, | |
| 1061 | the endpoint falls back to a deterministic heuristic so | |
| 1062 | the CLI keeps working. | |
| 1063 | </div> | |
| 1064 | </div> | |
| 1065 | </section> | |
| 1066 | ||
| bdb51e4 | 1067 | {/* ─── Shortcuts ─── */} |
| 1068 | <section id="shortcuts" class="help-section"> | |
| 1069 | <div class="help-section-head"> | |
| 1070 | <div class="help-section-eyebrow">Power user</div> | |
| 1071 | <h2 class="help-section-title">Keyboard shortcuts</h2> | |
| 1072 | <p class="help-section-desc"> | |
| 1073 | Press <code>?</code> on any page to pop the overlay. | |
| 1074 | </p> | |
| 1075 | </div> | |
| 1076 | <div class="help-section-body"> | |
| 1077 | <div class="help-item"> | |
| 1078 | gluecron ships a full keyboard-first mode — see{" "} | |
| 1079 | <a href="/shortcuts">/shortcuts</a> for the complete cheat | |
| 1080 | sheet. Press <code>?</code> on any page to pop the overlay. | |
| 80bed05 | 1081 | </div> |
| 1082 | </div> | |
| 1083 | </section> | |
| 1084 | ||
| bdb51e4 | 1085 | {/* ─── API ─── */} |
| 1086 | <section id="api" class="help-section"> | |
| 1087 | <div class="help-section-head"> | |
| 1088 | <div class="help-section-eyebrow">Reference</div> | |
| 1089 | <h2 class="help-section-title">API</h2> | |
| 1090 | <p class="help-section-desc"> | |
| 1091 | REST + GraphQL surfaces, both documented inline. | |
| 1092 | </p> | |
| 1093 | </div> | |
| 1094 | <div class="help-section-body"> | |
| 1095 | <div class="help-item"> | |
| 1096 | Full REST + GraphQL reference lives at{" "} | |
| 1097 | <a href="/api/docs">/api/docs</a>. The GraphQL explorer is at{" "} | |
| 1098 | <a href="/api/graphql">/api/graphql</a>. | |
| 80bed05 | 1099 | </div> |
| 1100 | </div> | |
| 1101 | </section> | |
| 1102 | ||
| c6018a5 | 1103 | {/* ─── Build-agent integration spec ─── */} |
| 1104 | <section id="build-agents" class="help-section"> | |
| 1105 | <div class="help-section-head"> | |
| 1106 | <div class="help-section-eyebrow">For AI vendors</div> | |
| 1107 | <h2 class="help-section-title">Build-agent integration</h2> | |
| 1108 | <p class="help-section-desc"> | |
| 1109 | Public spec for AI build-agent vendors (Holden Mercer, | |
| 1110 | Cursor, Claude Code, etc.) who want to read issues, open | |
| 1111 | PRs, and post review comments via the Gluecron API. | |
| 1112 | </p> | |
| 1113 | </div> | |
| 1114 | <div class="help-section-body"> | |
| 1115 | <div class="help-item"> | |
| 1116 | The full integration contract lives at{" "} | |
| 1117 | <a href="/docs/build-agent-integration">/docs/build-agent-integration</a>{" "} | |
| 1118 | — endpoint list, auth scopes, webhook payloads, and the | |
| 1119 | <code>ai:build</code> label convention. | |
| 1120 | </div> | |
| 0feb720 | 1121 | <div class="help-item"> |
| 1122 | Prefer model-context-protocol over REST? Same page now | |
| 1123 | documents the full 50+ <strong>MCP tool surface</strong> at{" "} | |
| 1124 | <a href="/docs/build-agent-integration#ba-mcp-title">/docs/build-agent-integration</a>{" "} | |
| 1125 | — every Gluecron action callable from any Claude/Cursor/etc. | |
| 1126 | tool-use loop. The JSON-RPC endpoint is{" "} | |
| 1127 | <code>POST /mcp</code>. | |
| 1128 | </div> | |
| c6018a5 | 1129 | </div> |
| 1130 | </section> | |
| 1131 | ||
| c4e643c | 1132 | {/* ─── Self-host (single binary) ─── */} |
| 1133 | <section id="self-host" class="help-section"> | |
| 1134 | <div class="help-section-head"> | |
| 1135 | <div class="help-section-eyebrow">Self-host</div> | |
| 1136 | <h2 class="help-section-title">Single-binary self-host</h2> | |
| 1137 | <p class="help-section-desc"> | |
| 1138 | GitHub Enterprise Server is a 50 GB blob and a week of | |
| 1139 | professional services. Gluecron self-host is a ~200 MB | |
| 1140 | binary and 60 seconds. One curl, you own the whole stack. | |
| 1141 | </p> | |
| 1142 | </div> | |
| 1143 | <div class="help-section-body"> | |
| 1144 | <div class="help-item"> | |
| 1145 | <strong>One-liner.</strong> | |
| 1146 | <pre><code>curl -fsSL https://gluecron.com/install-server | bash</code></pre> | |
| 1147 | The script detects your OS + arch, downloads the right | |
| 1148 | binary from <code>/dist/</code>, verifies SHA-256 against{" "} | |
| 1149 | <code>/dist/SHA256SUMS</code>, installs to{" "} | |
| 1150 | <code>/opt/gluecron/bin/gluecron-server</code> (or | |
| 1151 | <code>~/.gluecron/bin</code> with no sudo), provisions | |
| 1152 | Postgres, writes <code>/etc/gluecron.env</code>, runs | |
| 1153 | migrations, and starts the systemd unit (linux) or launchd | |
| 1154 | plist (darwin). | |
| 1155 | </div> | |
| 1156 | <div class="help-item"> | |
| 1157 | <strong>Hardware requirements.</strong> | |
| 1158 | <ul> | |
| 1159 | <li>4 GB RAM (8 GB for teams > 20)</li> | |
| 1160 | <li>20 GB disk for repos + Postgres data</li> | |
| 1161 | <li>Postgres 14+ (auto-installed via docker if missing)</li> | |
| 1162 | <li>Linux (x64 / arm64) or macOS (x64 / arm64)</li> | |
| 1163 | </ul> | |
| 1164 | </div> | |
| 1165 | <div class="help-item"> | |
| 1166 | <strong>Configuration walkthrough.</strong> The installer | |
| 1167 | writes <code>/etc/gluecron.env</code> seeded from{" "} | |
| 1168 | <code>.env.example</code>. At minimum, set: | |
| 1169 | <ul> | |
| 1170 | <li><code>DATABASE_URL</code> — Postgres connection string</li> | |
| 1171 | <li><code>APP_BASE_URL</code> — public URL of the instance</li> | |
| 1172 | <li><code>PORT</code> — listen port (default 3010)</li> | |
| 1173 | <li><code>GIT_REPOS_PATH</code> — bare-repo directory</li> | |
| 1174 | </ul> | |
| 1175 | Anything else (Anthropic key for AI features, GateTest | |
| 1176 | callback secret, OAuth providers) can be added later | |
| 1177 | without a restart via <code>/admin/integrations</code>. | |
| 1178 | </div> | |
| 1179 | <div class="help-item"> | |
| 1180 | <strong>Operations.</strong> | |
| 1181 | <ul> | |
| 1182 | <li> | |
| 1183 | <em>Backup.</em>{" "} | |
| 1184 | <code>pg_dump $DATABASE_URL | gzip > gluecron-$(date +%F).sql.gz</code>{" "} | |
| 1185 | plus <code>tar -czf repos-$(date +%F).tgz /opt/gluecron/repos</code>. | |
| 1186 | </li> | |
| 1187 | <li> | |
| 1188 | <em>Restore.</em> Stop systemd, restore the SQL dump | |
| 1189 | with <code>gunzip -c < dump.sql.gz | psql $DATABASE_URL</code>, | |
| 1190 | untar the repos, and start the unit. | |
| 1191 | </li> | |
| 1192 | <li> | |
| 1193 | <em>Upgrade.</em> Re-run the installer — it overwrites | |
| 1194 | the binary in place and restarts the service. The | |
| 1195 | migrations runner is idempotent. | |
| 1196 | </li> | |
| 1197 | <li> | |
| 1198 | <em>Logs.</em>{" "} | |
| 1199 | <code>journalctl -u gluecron -f</code> (linux) or{" "} | |
| 1200 | <code>tail -f ~/.gluecron/data/gluecron.err.log</code>{" "} | |
| 1201 | (darwin). | |
| 1202 | </li> | |
| 1203 | </ul> | |
| 1204 | </div> | |
| 1205 | <div class="help-item"> | |
| 1206 | <strong>Versus GitHub Enterprise Server.</strong> GHES is a | |
| 1207 | 50 GB OVA image, requires VMware/Hyper-V, and bills | |
| 1208 | per-seat. Gluecron self-host is a single binary, runs | |
| 1209 | anywhere bun runs, and is BYO-license. | |
| 1210 | </div> | |
| 1211 | </div> | |
| 1212 | </section> | |
| 1213 | ||
| bdb51e4 | 1214 | <p class="help-footnote"> |
| 80bed05 | 1215 | Something missing? Open an issue on gluecron's source repo. |
| 1216 | </p> | |
| 1217 | </div> | |
| 1218 | </Layout> | |
| 1219 | ); | |
| 1220 | }); | |
| 1221 | ||
| 1222 | export default help; |