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