From 2af64efd4ed5c08ded333395ed9de40ffd4d8aa2 Mon Sep 17 00:00:00 2001 From: ZTatman Date: Mon, 30 Mar 2026 16:34:35 -0400 Subject: [PATCH] Add CLI scaffold and config generators --- .gitignore | 1 + README.md | 9 ++ packages/cli/src/commands/init.ts | 91 +++++++++++++++++++ packages/cli/src/commands/start.ts | 12 +++ packages/cli/src/commands/status.ts | 34 +++++++ packages/cli/src/commands/stop.ts | 12 +++ packages/cli/src/generators/app-ini.ts | 14 +++ packages/cli/src/generators/docker-compose.ts | 43 +++++++++ packages/cli/src/generators/env.ts | 28 ++++++ packages/cli/src/generators/examples.ts | 23 +++++ packages/cli/src/generators/index.ts | 5 + packages/cli/src/index.ts | 53 +++++++++-- packages/cli/src/utils/crypto.ts | 6 ++ packages/cli/src/utils/docker.ts | 19 ++++ packages/cli/src/utils/flags.ts | 9 ++ 15 files changed, 349 insertions(+), 10 deletions(-) create mode 100644 packages/cli/src/commands/init.ts create mode 100644 packages/cli/src/commands/start.ts create mode 100644 packages/cli/src/commands/status.ts create mode 100644 packages/cli/src/commands/stop.ts create mode 100644 packages/cli/src/generators/app-ini.ts create mode 100644 packages/cli/src/generators/docker-compose.ts create mode 100644 packages/cli/src/generators/env.ts create mode 100644 packages/cli/src/generators/examples.ts create mode 100644 packages/cli/src/generators/index.ts create mode 100644 packages/cli/src/utils/crypto.ts create mode 100644 packages/cli/src/utils/docker.ts create mode 100644 packages/cli/src/utils/flags.ts diff --git a/.gitignore b/.gitignore index 20b5d90..0e9aa1a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ node_modules/ .DS_Store +.tmp/ dist/ coverage/ .env diff --git a/README.md b/README.md index a61cda1..c70ca91 100644 --- a/README.md +++ b/README.md @@ -23,3 +23,12 @@ Phase 1 is split into these reviewable branches: - Forgejo access is performed by a constrained service account with minimum PAT scopes. - A repo is shareable only if the service account can see it and Embargo has sharing enabled for it. +## Current CLI Surface + +```bash +pnpm --filter @embargo/cli build +node packages/cli/dist/index.js init --dir ./embargo +node packages/cli/dist/index.js status --dir ./embargo +node packages/cli/dist/index.js start --dir ./embargo +node packages/cli/dist/index.js stop --dir ./embargo +``` diff --git a/packages/cli/src/commands/init.ts b/packages/cli/src/commands/init.ts new file mode 100644 index 0000000..06e7373 --- /dev/null +++ b/packages/cli/src/commands/init.ts @@ -0,0 +1,91 @@ +import { mkdir, writeFile } from "node:fs/promises"; +import path from "node:path"; + +import { + generateAppIni, + generateDockerCompose, + generateEnvFile, + generateExampleCaddyfile, + generateExampleNginxConf +} from "../generators/index.js"; +import { generateSecret } from "../utils/crypto.js"; +import { assertDockerPrerequisites } from "../utils/docker.js"; +import { getFlagValue } from "../utils/flags.js"; + +interface InitOptions { + domain: string; + forgejoAdminPassword: string; + forgejoAdminUser: string; + outputDir: string; + visibilityMode: "allowlist" | "team"; +} + +function parseInitOptions(argv: string[]): InitOptions { + return { + domain: getFlagValue(argv, "--domain") ?? "localhost", + forgejoAdminPassword: getFlagValue(argv, "--forgejo-admin-password") ?? "change-me", + forgejoAdminUser: getFlagValue(argv, "--forgejo-admin-user") ?? "admin", + outputDir: getFlagValue(argv, "--dir") ?? "embargo", + visibilityMode: (getFlagValue(argv, "--visibility-mode") as InitOptions["visibilityMode"] | undefined) ?? "team" + }; +} + +export async function initCommand(argv: string[]): Promise { + const options = parseInitOptions(argv); + + if (options.visibilityMode !== "team" && options.visibilityMode !== "allowlist") { + throw new Error(`Unsupported visibility mode: ${options.visibilityMode}`); + } + + assertDockerPrerequisites(); + + const outputRoot = path.resolve(process.cwd(), options.outputDir); + const forgejoDir = path.join(outputRoot, "forgejo"); + const examplesDir = path.join(outputRoot, "examples"); + + await mkdir(forgejoDir, { recursive: true }); + await mkdir(examplesDir, { recursive: true }); + + const generatedSecrets = { + dbPassword: generateSecret(), + embargoAdminPassword: generateSecret(), + forgejoServicePassword: generateSecret(), + jwtSecret: generateSecret() + }; + + await Promise.all([ + writeFile( + path.join(outputRoot, "docker-compose.yml"), + generateDockerCompose({ domain: options.domain }), + "utf8" + ), + writeFile( + path.join(outputRoot, ".env"), + generateEnvFile({ + domain: options.domain, + forgejoAdminPassword: options.forgejoAdminPassword, + forgejoAdminUser: options.forgejoAdminUser, + visibilityMode: options.visibilityMode, + ...generatedSecrets + }), + "utf8" + ), + writeFile(path.join(forgejoDir, "app.ini"), generateAppIni(), "utf8"), + writeFile(path.join(examplesDir, "Caddyfile"), generateExampleCaddyfile(options.domain), "utf8"), + writeFile(path.join(examplesDir, "nginx.conf"), generateExampleNginxConf(options.domain), "utf8") + ]); + + process.stdout.write( + [ + `Generated Embargo scaffold in ${outputRoot}`, + `Visibility mode: ${options.visibilityMode}`, + "Generated files:", + "- docker-compose.yml", + "- .env", + "- forgejo/app.ini", + "- examples/Caddyfile", + "- examples/nginx.conf" + ].join("\n") + "\n" + ); +} + diff --git a/packages/cli/src/commands/start.ts b/packages/cli/src/commands/start.ts new file mode 100644 index 0000000..6bd8956 --- /dev/null +++ b/packages/cli/src/commands/start.ts @@ -0,0 +1,12 @@ +import path from "node:path"; + +import { assertDockerPrerequisites, getComposeCommand } from "../utils/docker.js"; +import { getFlagValue } from "../utils/flags.js"; + +export async function startCommand(argv: string[]): Promise { + assertDockerPrerequisites(); + + const outputDir = path.resolve(process.cwd(), getFlagValue(argv, "--dir") ?? "embargo"); + process.stdout.write(`${getComposeCommand(outputDir)} up -d\n`); +} + diff --git a/packages/cli/src/commands/status.ts b/packages/cli/src/commands/status.ts new file mode 100644 index 0000000..58b534f --- /dev/null +++ b/packages/cli/src/commands/status.ts @@ -0,0 +1,34 @@ +import { access } from "node:fs/promises"; +import path from "node:path"; + +import { assertDockerPrerequisites } from "../utils/docker.js"; +import { getFlagValue } from "../utils/flags.js"; + +const REQUIRED_FILES = [ + "docker-compose.yml", + ".env", + "forgejo/app.ini", + "examples/Caddyfile", + "examples/nginx.conf" +] as const; + +export async function statusCommand(argv: string[]): Promise { + assertDockerPrerequisites(); + + const outputDir = path.resolve(process.cwd(), getFlagValue(argv, "--dir") ?? "embargo"); + const results = await Promise.all( + REQUIRED_FILES.map(async (file) => { + const filePath = path.join(outputDir, file); + + try { + await access(filePath); + return `OK ${file}`; + } catch { + return `MISS ${file}`; + } + }) + ); + + process.stdout.write([`Scaffold directory: ${outputDir}`, ...results].join("\n") + "\n"); +} + diff --git a/packages/cli/src/commands/stop.ts b/packages/cli/src/commands/stop.ts new file mode 100644 index 0000000..463deaf --- /dev/null +++ b/packages/cli/src/commands/stop.ts @@ -0,0 +1,12 @@ +import path from "node:path"; + +import { assertDockerPrerequisites, getComposeCommand } from "../utils/docker.js"; +import { getFlagValue } from "../utils/flags.js"; + +export async function stopCommand(argv: string[]): Promise { + assertDockerPrerequisites(); + + const outputDir = path.resolve(process.cwd(), getFlagValue(argv, "--dir") ?? "embargo"); + process.stdout.write(`${getComposeCommand(outputDir)} down\n`); +} + diff --git a/packages/cli/src/generators/app-ini.ts b/packages/cli/src/generators/app-ini.ts new file mode 100644 index 0000000..44f0ec4 --- /dev/null +++ b/packages/cli/src/generators/app-ini.ts @@ -0,0 +1,14 @@ +export function generateAppIni(): string { + return `[service] +DISABLE_REGISTRATION = true +DEFAULT_ORG_VISIBILITY = private + +[repository] +DEFAULT_PRIVATE = private +FORCE_PRIVATE = true + +[server] +HTTP_PORT = 3000 +`; +} + diff --git a/packages/cli/src/generators/docker-compose.ts b/packages/cli/src/generators/docker-compose.ts new file mode 100644 index 0000000..d0fa5bd --- /dev/null +++ b/packages/cli/src/generators/docker-compose.ts @@ -0,0 +1,43 @@ +export function generateDockerCompose({ domain }: { domain: string }): string { + return `services: + postgres: + image: postgres:16 + restart: unless-stopped + env_file: + - .env + volumes: + - postgres-data:/var/lib/postgresql/data + + forgejo: + image: codeberg.org/forgejo/forgejo:11.0.11 + restart: unless-stopped + env_file: + - .env + depends_on: + - postgres + ports: + - "3000:3000" + - "2222:22" + volumes: + - ./forgejo/app.ini:/data/gitea/conf/app.ini + + embargo-service: + image: node:22-alpine + restart: unless-stopped + env_file: + - .env + depends_on: + - forgejo + ports: + - "4000:4000" + environment: + EMBARGO_DOMAIN: ${domain} + volumes: + - embargo-data:/data + +volumes: + postgres-data: + embargo-data: +`; +} + diff --git a/packages/cli/src/generators/env.ts b/packages/cli/src/generators/env.ts new file mode 100644 index 0000000..1cbcee0 --- /dev/null +++ b/packages/cli/src/generators/env.ts @@ -0,0 +1,28 @@ +interface EnvOptions { + dbPassword: string; + domain: string; + embargoAdminPassword: string; + forgejoAdminPassword: string; + forgejoAdminUser: string; + forgejoServicePassword: string; + jwtSecret: string; + visibilityMode: "allowlist" | "team"; +} + +export function generateEnvFile(options: EnvOptions): string { + return `EMBARGO_DOMAIN=${options.domain} +EMBARGO_ADMIN_PASSWORD=${options.embargoAdminPassword} +JWT_SECRET=${options.jwtSecret} + +FORGEJO_ADMIN_USERNAME=${options.forgejoAdminUser} +FORGEJO_ADMIN_PASSWORD=${options.forgejoAdminPassword} +FORGEJO_SERVICE_ACCOUNT=embargo-bot +FORGEJO_SERVICE_ACCOUNT_PASSWORD=${options.forgejoServicePassword} +FORGEJO_VISIBILITY_MODE=${options.visibilityMode} + +POSTGRES_DB=forgejo +POSTGRES_USER=forgejo +POSTGRES_PASSWORD=${options.dbPassword} +`; +} + diff --git a/packages/cli/src/generators/examples.ts b/packages/cli/src/generators/examples.ts new file mode 100644 index 0000000..b2d9304 --- /dev/null +++ b/packages/cli/src/generators/examples.ts @@ -0,0 +1,23 @@ +export function generateExampleCaddyfile(domain: string): string { + return `${domain} { + reverse_proxy /_embargo/* localhost:4000 + reverse_proxy localhost:3000 +} +`; +} + +export function generateExampleNginxConf(domain: string): string { + return `server { + server_name ${domain}; + + location /_embargo/ { + proxy_pass http://127.0.0.1:4000/; + } + + location / { + proxy_pass http://127.0.0.1:3000/; + } +} +`; +} + diff --git a/packages/cli/src/generators/index.ts b/packages/cli/src/generators/index.ts new file mode 100644 index 0000000..65ade65 --- /dev/null +++ b/packages/cli/src/generators/index.ts @@ -0,0 +1,5 @@ +export * from "./app-ini.js"; +export * from "./docker-compose.js"; +export * from "./env.js"; +export * from "./examples.js"; + diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts index f7c256f..f5df6b0 100644 --- a/packages/cli/src/index.ts +++ b/packages/cli/src/index.ts @@ -1,14 +1,47 @@ -import { EMBARGO_DEFAULT_FORGEJO_PORT, EMBARGO_DEFAULT_SERVICE_PORT } from "@embargo/shared"; +#!/usr/bin/env node -function main(): void { - process.stdout.write( - [ - "Embargo CLI bootstrap", - `Forgejo default port: ${EMBARGO_DEFAULT_FORGEJO_PORT}`, - `Service default port: ${EMBARGO_DEFAULT_SERVICE_PORT}` - ].join("\n") + "\n" - ); +import { initCommand } from "./commands/init.js"; +import { startCommand } from "./commands/start.js"; +import { statusCommand } from "./commands/status.js"; +import { stopCommand } from "./commands/stop.js"; + +type CommandName = "init" | "start" | "status" | "stop"; + +const HELP_TEXT = `Embargo CLI + +Usage: + embargo [options] + +Commands: + init Generate the local Embargo stack scaffold + start Print the docker compose command used to start the stack + stop Print the docker compose command used to stop the stack + status Validate docker tooling and generated files +`; + +async function main(): Promise { + const [command, ...args] = process.argv.slice(2); + + if (!command || command === "--help" || command === "-h") { + process.stdout.write(`${HELP_TEXT}\n`); + return; + } + + const knownCommands: Record Promise> = { + init: initCommand, + start: startCommand, + status: statusCommand, + stop: stopCommand + }; + + if (!(command in knownCommands)) { + process.stderr.write(`Unknown command: ${command}\n\n${HELP_TEXT}\n`); + process.exitCode = 1; + return; + } + + await knownCommands[command as CommandName](args); } -main(); +void main(); diff --git a/packages/cli/src/utils/crypto.ts b/packages/cli/src/utils/crypto.ts new file mode 100644 index 0000000..33ebd05 --- /dev/null +++ b/packages/cli/src/utils/crypto.ts @@ -0,0 +1,6 @@ +import { randomBytes } from "node:crypto"; + +export function generateSecret(bytes = 24): string { + return randomBytes(bytes).toString("hex"); +} + diff --git a/packages/cli/src/utils/docker.ts b/packages/cli/src/utils/docker.ts new file mode 100644 index 0000000..afd9b05 --- /dev/null +++ b/packages/cli/src/utils/docker.ts @@ -0,0 +1,19 @@ +import { spawnSync } from "node:child_process"; + +function assertCommand(command: string, args: string[] = []): void { + const result = spawnSync(command, args, { stdio: "ignore" }); + + if (result.status !== 0) { + throw new Error(`Required command not available: ${[command, ...args].join(" ")}`); + } +} + +export function assertDockerPrerequisites(): void { + assertCommand("docker", ["--version"]); + assertCommand("docker", ["compose", "version"]); +} + +export function getComposeCommand(outputDir: string): string { + return `docker compose --project-directory ${outputDir}`; +} + diff --git a/packages/cli/src/utils/flags.ts b/packages/cli/src/utils/flags.ts new file mode 100644 index 0000000..2976efe --- /dev/null +++ b/packages/cli/src/utils/flags.ts @@ -0,0 +1,9 @@ +export function getFlagValue(argv: string[], flag: string): string | undefined { + const index = argv.indexOf(flag); + + if (index === -1) { + return undefined; + } + + return argv[index + 1]; +}