@portosaur/cli 0.1.0

package/README.md

@@ -0,0 +1,52 @@
+# porto
+
+The primary command-line interface for Portosaur.
+
+## Installation
+
+```bash
+# Global installation
+bun install -g @portosaur/cli  # or npm install -g @portosaur/cli
+
+# Or use directly with bunx/npx
+bunx @portosaur/cli@latest # or npx @portosaur/cli@latest
+```
+
+## Commands
+
+- `porto init [-P name]` — Initialize a new project (interactive mode recommended).
+- `porto init-ci [-h id]` — Set up CI/CD for an existing project.
+- `porto dev` — Start the development server.
+- `porto build` — Generate a static production build.
+- `porto serve` — Preview a production build locally.
+- `porto schema` — Output the JSON schema for validation.
+
+## Usage
+
+```bash
+# Interactive mode (recommended)
+porto init
+
+# Or with project name
+porto init -P my-portfolio
+
+# With all options (non-interactive)
+porto init -P my-site -p github -h github-pages -u myusername -n "My Name"
+
+# Start development
+cd my-portfolio
+bun run dev
+
+# Build for production
+bun run build
+```
+
+## Library Usage
+
+If you want to use Portosaur programmatically, install `@portosaur/core`:
+
+```bash
+npm install @portosaur/core
+```
+
+See `@portosaur/core` for API documentation.

package/bin/porto.mjs

@@ -0,0 +1,71 @@
+#!/usr/bin/env bun
+
+import { Command, Argument } from "commander";
+import { porto } from "@portosaur/core";
+import { initCommand } from "../src/commands/init.mjs";
+import { initCiCommand } from "../src/commands/initCi.mjs";
+import { devCommand } from "../src/commands/dev.mjs";
+import { buildCommand } from "../src/commands/build.mjs";
+import { serveCommand } from "../src/commands/serve.mjs";
+import { schemaCommand } from "../src/commands/schema.mjs";
+import { providersCommand } from "../src/commands/providers.mjs";
+
+const program = new Command();
+
+program
+  .name("porto")
+  .description("CLI for Portosaur — The complete portfolio solution")
+  .version(porto.version, "-v, --version", "output the current version")
+  .helpOption("--help", "output usage information");
+
+program
+  .command("init")
+  .description("Initialize a new Portosaur project")
+  .option("-p, --vcs-provider <id>", "VCS Provider ID")
+  .option("-h, --hosting <id>", "Hosting Platform ID")
+  .option("-u, --username <user>", "VCS username")
+  .option("-n, --name <name>", "Full name for portfolio")
+  .option("-P, --project-name <name>", "Project name")
+  .option("-k, --no-install", "Skip dependency installation")
+  .action((options) => initCommand(options));
+
+program
+  .command("init-ci")
+  .description("Setup CI/CD workflows for an existing project")
+  .option("-h, --hosting <id>", "Hosting Platform ID")
+  .action((options) => initCiCommand(options));
+
+program
+  .command("providers")
+  .description("List available VCS providers and hosting platforms")
+  .addArgument(
+    new Argument("[type]", "Filter list by type").choices(["vcs", "hosting"]),
+  )
+  .action((type) => providersCommand(type));
+
+program
+  .command("dev [siteDir] [extraArgs...]")
+  .alias("start")
+  .description("Start the development server")
+  .allowUnknownOption()
+  .action(devCommand);
+
+program
+  .command("build [siteDir] [extraArgs...]")
+  .description("Build the static site")
+  .allowUnknownOption()
+  .action(buildCommand);
+
+program
+  .command("serve [siteDir]")
+  .description("Serve the built static site locally")
+  .action(serveCommand);
+
+program
+  .command("schema", { hidden: true })
+  .description("Generate the config schema")
+  .option("-c, --config <path>", "Path to the source file to scan")
+  .option("-o, --output <path>", "Path to output the schema file")
+  .action(schemaCommand);
+
+program.parse();

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@portosaur/cli",
+  "version": "0.1.0",
+  "description": "Portosaur CLI: Personal portfolio site generator.",
+  "license": "GPL-3.0-only",
+  "author": "soymadip",
+  "homepage": "https://soymadip.github.io/portosaur",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/soymadip/portosaur"
+  },
+  "files": [
+    "src",
+    "bin",
+    "templates"
+  ],
+  "type": "module",
+  "bin": {
+    "porto": "./bin/porto.mjs"
+  },
+  "exports": {
+    ".": {
+      "import": "./src/index.mjs",
+      "default": "./src/index.mjs"
+    }
+  },
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "@portosaur/core": "workspace:*",
+    "@portosaur/theme": "workspace:*",
+    "@portosaur/logger": "workspace:*",
+    "@portosaur/wizard": "workspace:*",
+    "commander": "^13.1.0",
+    "js-yaml": "^4.1.1"
+  }
+}

package/src/commands/build.mjs

@@ -0,0 +1,85 @@
+import fs from "fs";
+import path from "path";
+import {
+  Paths,
+  writeConfigShim,
+  runDocusaurus,
+  validateProject,
+  ensureContentDirs,
+} from "../utils/index.mjs";
+import { logger } from "@portosaur/logger";
+import {
+  loadUserConfig,
+  generateFavicons,
+  generateRobotsTxt,
+} from "@portosaur/core";
+
+/**
+ * Builds the static Portosaur site.
+ *
+ * This involves:
+ * 1. Validating the project structure.
+ * 2. Generating dynamic assets (favicons, robots.txt).
+ * 3. Compiling the site via Docusaurus.
+ */
+export async function buildCommand(siteDir, extraArgs = []) {
+  const UserRoot = siteDir
+    ? path.resolve(process.cwd(), siteDir)
+    : process.cwd();
+
+  // ------- Setup -------
+
+  validateProject(UserRoot);
+  ensureContentDirs(UserRoot);
+
+  /*
+   * ====================== Path Resolution ======================
+   */
+
+  const portoPaths = {
+    root: Paths.root,
+    assets: path.join(Paths.theme, "assets"),
+    theme: path.join(Paths.theme, "theme"),
+    plugins: path.join(Paths.theme, "src/plugins"),
+  };
+
+  try {
+    const userConfig = loadUserConfig(UserRoot);
+
+    // ------- Asset Generation -------
+
+    logger.info("Generating site assets...");
+
+    const faviconRes = await generateFavicons(UserRoot, {
+      imagePath: userConfig.home_page?.hero?.profile_pic,
+      siteTitle: userConfig.site?.title,
+      siteTagline: userConfig.site?.tagline,
+      staticDirs: ["static"],
+    });
+
+    const configPath = writeConfigShim(UserRoot, portoPaths, {
+      extraHeadTags: faviconRes.html,
+    });
+
+    // ------- Docusaurus Build -------
+
+    logger.info("Building static site...");
+
+    await runDocusaurus("build", UserRoot, configPath, extraArgs);
+
+    // ------- Post Build -------
+
+    await generateRobotsTxt(UserRoot, {
+      enable: userConfig.site?.robots_txt?.enable,
+      rules: userConfig.site?.robots_txt?.rules,
+      customLines: userConfig.site?.robots_txt?.custom_lines,
+      siteUrl: userConfig.site?.url,
+      baseUrl: userConfig.site?.path,
+    });
+
+    logger.success("Build completed successfully!");
+  } catch (error) {
+    logger.error(`Build failed: ${error.message}`);
+    process.exit(1);
+  }
+}

package/src/commands/dev.mjs

@@ -0,0 +1,61 @@
+import path from "path";
+import fs from "fs";
+import {
+  Paths,
+  writeConfigShim,
+  runDocusaurus,
+  validateProject,
+  ensureContentDirs,
+} from "../utils/index.mjs";
+import { logger } from "@portosaur/logger";
+
+export async function devCommand(siteDir, extraArgs = []) {
+  const UserRoot = siteDir
+    ? path.resolve(process.cwd(), siteDir)
+    : process.cwd();
+
+  validateProject(UserRoot);
+  ensureContentDirs(UserRoot);
+
+  const configYaml = ["config.yaml", "config.yml"].find((file) =>
+    fs.existsSync(path.join(UserRoot, file)),
+  );
+
+  /*
+   * ====================== Path Resolution ======================
+   */
+
+  const portoPaths = {
+    root: Paths.root,
+    assets: path.join(Paths.theme, "assets"),
+    theme: path.join(Paths.theme, "theme"),
+    plugins: path.join(Paths.theme, "src/plugins"),
+  };
+
+  try {
+    const configPath = writeConfigShim(UserRoot, portoPaths);
+
+    // Watch for config.yml changes to trigger Docusaurus reload
+    if (configYaml) {
+      const configYamlPath = path.join(UserRoot, configYaml);
+      const watcher = fs.watch(configYamlPath, (eventType) => {
+        if (eventType === "change") {
+          logger.info(`Detected change in ${configYaml}, reloading...`);
+          // Touch the shim config to trigger Docusaurus reload
+          const now = new Date();
+          fs.utimesSync(configPath, now, now);
+        }
+      });
+
+      process.on("SIGINT", () => {
+        watcher.close();
+        process.exit();
+      });
+    }
+
+    await runDocusaurus("start", UserRoot, configPath, extraArgs);
+  } catch (error) {
+    logger.error(`Failed to start dev server: ${error.message}`);
+    process.exit(1);
+  }
+}