firebreak/packages/cli/src/commands/config/init.ts
ZTatman 29cd2f046d simplify: reduce CLI config to just Forgejo URL and PAT
Removes unnecessary configuration that operators dont need to provide:
- Removed MYST_PUBLIC_URL, MYST_ADMIN_URL (users buy their own domains)
- Removed FORGEJO_BOT_USERNAME (API returns username)
- Removed DATABASE_URL (Docker Compose handles it)
- Removed GRANT_TOKEN_SECRET (auto-generated on startup)

Simplifies init to just 2 prompts:
- Forgejo base URL
- Forgejo PAT

Adds Docker Compose example with PostgreSQL.

Verify now shows:
- FORGEJO_BASE_URL configured
- FORGEJO_PAT configured
- Forgejo is reachable
- Forgejo User <username> has <n> repositories
2026-04-15 20:53:58 -04:00

194 lines
5.4 KiB
TypeScript

import fs from "node:fs/promises";
import path from "node:path";
import * as c from "yoctocolors";
import * as p from "@clack/prompts";
import { generateEnvFile, SECRET_ENV_KEYS } from "../../utils/config.js";
import { CommandConfig } from "../../cli-router.js";
function normalizeHttpUrl(value: string): string {
const trimmed = value.trim();
const hasProtocol = /^[a-z]+:\/\//i.test(trimmed);
const isNotHttp = !/^https?:\/\//i.test(trimmed);
if (hasProtocol && isNotHttp) {
throw new Error("URLs must use http:// or https://");
}
return hasProtocol ? trimmed : `https://${trimmed}`;
}
function validateHttpUrlOrHost(
value: string | undefined,
label: string,
): string | undefined {
if (!value?.trim()) return `${label} is required`;
try {
const normalized = normalizeHttpUrl(value);
const url = new URL(normalized);
if (!url.hostname) {
return `${label} must include a domain or hostname`;
}
} catch {
return `${label} must be a valid URL or hostname`;
}
return undefined;
}
async function init(opts: { output?: string }) {
p.intro(c.bold("myst config init"));
p.note(
[
`${c.bold("Run this in the directory where you plan to deploy Myst.")}`,
"",
c.bold("Forgejo docs:"),
"",
`- API usage: ${c.cyan("https://forgejo.org/docs/latest/user/api-usage/")}`,
`- Token scopes: ${c.cyan("https://forgejo.org/docs/latest/user/token-scope/")}`,
`- Repo permissions: ${c.cyan("https://forgejo.org/docs/latest/user/repo-permissions/")}`,
`- Admin CLI: ${c.cyan("https://forgejo.org/docs/latest/admin/command-line/")}`,
"",
`1. Generate a PAT in Forgejo ${c.bold("Settings -> Applications")}.`,
`2. Generate a PAT with the appropriate scopes for your Forgejo setup.`,
"",
`Recommended PAT scopes:\n - ${c.bold("read:user")}\n - ${c.bold("read:repository")}\n - ${c.bold("read:organization")} (optional)`,
].join("\n"),
c.yellow("Before you start:"),
);
const envPath = opts.output || path.join(process.cwd(), ".env");
// Check if .env file already exists
let envExists = false;
try {
await fs.stat(envPath);
envExists = true;
} catch {
// .env file does not exist
}
// Handle existing .env file
if (envExists) {
while (true) {
const choice = await p.select({
message: c.red(
`The file .env already exists at ${envPath}. What would you like to do?`,
),
options: [
{ value: "view", label: "View .env content" },
{ value: "overwrite", label: "Overwrite .env" },
{ value: "cancel", label: "Cancel" },
],
});
if (p.isCancel(choice) || choice === "cancel") {
p.cancel("\nOperation cancelled.");
process.exitCode = 0;
return;
}
if (choice === "view") {
const envContent = await fs.readFile(envPath, { encoding: "utf-8" });
const maskedEnvContent = envContent
.split("\n")
.map((line) => {
if (!line.includes("=")) return line;
const [key] = line.split("=");
return SECRET_ENV_KEYS.includes(key as typeof SECRET_ENV_KEYS[number])
? `${key}=****`
: line;
})
.join("\n");
p.note(c.dim(maskedEnvContent), c.yellow("Current .env"));
continue;
}
if (choice === "overwrite") {
break;
}
}
}
const answers = await p.group(
{
forgejoBaseUrl: () =>
p.text({
message: "Domain name or URL for your existing Forgejo instance?",
placeholder: "git.example.com",
validate: (v) => validateHttpUrlOrHost(v, "Forgejo base URL"),
}),
forgejoPat: () =>
p.password({
message: "Paste the Forgejo personal access token",
mask: "*",
validate: (v) => (v?.trim() ? undefined : "Forgejo PAT is required"),
}),
},
{
onCancel: () => {
p.cancel("\nOperation cancelled.");
process.exitCode = 0;
},
},
);
const s = p.spinner();
try {
s.start("Generating config files");
const forgejoBaseUrl = normalizeHttpUrl(answers.forgejoBaseUrl);
const envContent = generateEnvFile({
forgejoBaseUrl,
forgejoPat: answers.forgejoPat,
});
if (envExists) {
const tempPath = envPath + ".tmp";
await fs.writeFile(tempPath, envContent, {
encoding: "utf8",
flag: "wx",
mode: 0o600,
});
await fs.unlink(envPath).catch(() => {});
await fs.rename(tempPath, envPath);
} else {
await fs.writeFile(envPath, envContent, {
encoding: "utf8",
flag: "wx",
mode: 0o600,
});
}
s.stop(c.yellow(`.env created at ${envPath}`));
p.note(
[
`${c.bold("Forgejo base URL:")} ${c.cyan(forgejoBaseUrl)}`,
"",
`Configure your public and admin URLs using your reverse proxy (Caddy, Nginx, etc.).`,
].join("\n"),
);
p.log.success(
"Done. Verify myst's connection using the 'verify' command.\nOnce verified, deploy!",
);
} catch (error) {
s.stop();
p.cancel(
error instanceof Error ? error.message : "Failed to initialize Myst",
);
process.exitCode = 1;
}
}
export const commandConfig: CommandConfig = {
description: "Generate .env file",
options: {
output: { type: "string", short: "o" },
},
handler: init,
};