@portosaur/cli 0.1.0

package/src/templates/README.md

@@ -0,0 +1,58 @@
+# {{projectName}}
+
+Welcome to my digital personality and portfolio! 👋
+
+This is my personal space on the web to express myself, share my thoughts, and showcase my work to the world.
+
+## About This Repository
+
+This repository contains the source code for my personal website, built with [Portosaur]({{portoHome}}).
+
+It serves as my:
+
+- **Portfolio**: Highlighting my projects, skills, and professional experience.
+- **Digital Notebook**: A collection of notes, snippets, and ongoing learnings.
+- **Blog**: Long-form articles and deep dives.
+
+## Local Development
+
+If you'd like to explore the code or run this site locally:
+
+1. **Clone the repository:**
+
+   ```bash
+   git clone https://github.com/<MyUserName>/{{projectName}}.git
+   cd {{projectName}}
+   ```
+
+2. **Install dependencies:**
+
+   ```bash
+   bun install
+   ```
+
+   _(npm, yarn, or pnpm work too!)_
+
+3. **Start the development server:**
+
+   ```bash
+   bun run dev
+   ```
+
+4. **Build for production:**
+   ```bash
+   bun run build
+   ```
+
+## Structure
+
+- `config.js` — The configuration for my site.
+- `notes/` — Markdown/MDX files for my digital Notebook.
+- `blog/` — Articles and blog posts.
+- `static/` — Static assets like images and my resume.
+
+---
+
+<br/>
+
+_Powered by [Portosaur]({{portoHome}})_

package/src/templates/blog/authors.yml

@@ -0,0 +1,4 @@
+you:
+  name: Your Name
+  title: Author
+  url: https://github.com/yourprofile

package/src/templates/blog/welcome.md

@@ -0,0 +1,11 @@
+---
+title: Welcome to the Blog
+authors: [you]
+tags: [welcome]
+---
+
+Your first blog post! Edit or delete this file to get started.
+
+<!-- truncate -->
+
+This is a blog powered by [Portosaur](https://github.com/soymadip/portosaur).

package/src/templates/config.yml

@@ -0,0 +1,150 @@
+# yaml-language-server: $schema=https://soymadip.github.io/portosaur/conf-schema.json
+# Portosaur Project Configuration
+# This file is filled with example values
+# Check Config Docs: https://soymadip.is-a.dev/portosaur/guide/config
+
+# Site Metadata & SEO
+site:
+  title: "{{fullName}}"
+  tagline: "Short description about you, your passion, your goals etc."
+
+  favicon: "{{portoRoot}}/src/assets/img/svg/icon.svg"
+  social_card: "{{portoRoot}}/src/assets/img/social-card.jpeg"
+
+  # Auto set if deploying in Github/GitLab Pages
+  url: "auto"
+  path: "auto"
+
+# UI/UX & Theme Behavior
+theme:
+  appearance:
+    dark_mode: true
+    disable_switch: false
+
+  navigation:
+    collapsable_sidebar: true
+    hide_navbar_on_scroll: true
+
+# Page Content & Sections
+home_page:
+  hero:
+    title: null # Fallback to {{site.title}}
+    profession: "Your Profession"
+    desc: null # Fallback to {{site.tagline}}
+    profile_pic: null # Fallback to {{site.favicon}}
+
+    social:
+      - name: "LinkedIn"
+        url: "https://www.linked.com/in/{{userName}}"
+
+      - name: "GitHub"
+        icon: "githubalt"
+        url: "https://github.com/{{userName}}"
+
+      - name: "Telegram"
+        url: "https://t.me/{{userName}}"
+
+  about:
+    enable: true
+    image: null # Fallback to {{home_page.hero.profile_pic}}
+    bio:
+      - "I'm a {{home_page.hero.profession}} who loves turning ideas into reality."
+      - "With a background in computer science and a passion for design, I bridge the gap between aesthetics and functionality."
+      - "Also I am interested in Your interest1, interest2 etc etc......"
+    skills:
+      - "skill 1"
+      - "skill 2"
+      - "skill 3"
+    resume: "{{portoRoot}}/src/assets/sample-resume.pdf"
+
+  project_shelf:
+    enable: true
+    projects:
+      - title: "Your Awesome Project"
+        icon: null
+        state: "active" # options: active, completed, maintenance, paused, archived, planned
+        desc: "A brief description of what this project does and the tech used."
+        tags: ["tag1", "tag2", "tag3", "tag4", "tag5", "tag6", "tag7"]
+        website: "https://example.com"
+        repo: "https://github.com/yourname/project1"
+
+      - title: "Your Awesome Project 2"
+        icon: "{{portoRoot}}/src/assets/img/svg/icon.svg"
+        bg: "#5c8f2d"
+        tags: ["tag1", "tag2", "tag3", "tag4", "tag5", "tag6", "tag7"]
+        featured: true
+        state: "completed"
+        desc: "A brief description of what this project does and the tech used."
+        website: "https://example.com"
+        repo: "https://github.com/yourname/project2"
+        demo: "https://example.com/demo"
+
+      - title: "Your Awesome Project 3"
+        icon: "https://github.com/soymadip/KireiSakura-Kit/blob/main/Assets/icon.png?raw=true"
+        bg: "#aa47be"
+        state: "completed"
+        desc: "A brief description of what this project does and the tech used."
+        website: "https://example.com"
+        repo: "https://github.com/yourname/project2"
+        demo: "https://example.com/demo"
+
+  experience:
+    enable: false
+    list:
+      - company: "Tech Solutions Inc."
+        role: "Senior Developer"
+        duration: "2022 - Present"
+        desc: "Leading the frontend team in building a high-performance dashboard."
+
+  # Reach me out section
+  social:
+    enable: true
+    links:
+      - name: "Email"
+        desc: "Send me an email"
+        url: "mailto:yourname@example.com"
+
+      - name: "LinkedIn"
+        desc: "Connect on LinkedIn"
+        url: "https://linkedin.com/in/{{userName}}"
+
+      - name: "Telegram"
+        desc: "Reach me on Telegram"
+        url: "https://t.me/{{userName}}"
+
+      - name: "Discord"
+        desc: "Become my friend"
+        url: "https://discord.com/users/yourid"
+
+      - name: "Twitter"
+        desc: "Find me on Twitter"
+        url: "https://twitter.com/{{userName}}"
+
+      - name: "GitLab"
+        desc: "View my GitLab profile"
+        url: "https://gitlab.com/{{userName}}"
+
+      - name: "Anilist"
+        desc: "If you are otaku, check out!"
+        url: "https://anilist.co/user/{{userName}}"
+
+tasks:
+  enable: true
+  list:
+    - title: "Build the future"
+      status: "done"
+      desc: "Implementing the core framework."
+
+# Functional Tools
+tools:
+  link_shortener:
+    enable: false
+    deploy_path: "/l"
+    short_links:
+      "example": "https://example.com"
+
+# Custom variables for use in your content as {{custom.key}}
+custom:
+  twitter: "@{{userName}}"
+  github: "{{userName}}"
+  linkedin: "{{userName}}"

package/src/templates/gitignore

@@ -0,0 +1,9 @@
+# gitignore, init time renamed
+
+node_modules/
+.docusaurus/
+.portosaur/
+.cache-loader/
+build/
+notes/index.md*
+test*

package/src/templates/notes/index.mdx

@@ -0,0 +1,9 @@
+---
+hide_table_of_contents: true
+---
+
+import NoteCards from "portosaur/src/theme/components/NoteIndex/index.js";
+
+# Notes
+
+<NoteCards />

package/src/templates/notes/welcome.mdx

@@ -0,0 +1,9 @@
+---
+id: "welcome-to-notes"
+author: "Portosaur"
+description: "Welcome to the notes section"
+---
+
+# Welcome
+
+Welcome to your notes! Add markdown or MDX files in this `notes/` directory.

package/src/templates/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "{{projectName}}",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "$npm_execpath install && porto dev",
+    "start": "$npm_execpath install && porto start",
+    "build": "$npm_execpath install && porto build",
+    "serve": "porto serve"
+  },
+  "dependencies": {
+    "@portosaur/cli": "^{{portoVer}}"
+  }
+}

package/src/templates/registry.yml

@@ -0,0 +1,107 @@
+vcs_providers:
+  github:
+    name: GitHub
+    domain: github.com
+    default_hosting: github-pages
+    url: "https://{{domain}}/{{user}}/{{projectName}}.git"
+    new_url: "https://{{domain}}/new?name={{projectName}}"
+
+  gitlab:
+    name: GitLab
+    domain: gitlab.com
+    default_hosting: gitlab-pages
+    url: "https://{{domain}}/{{user}}/{{projectName}}.git"
+    new_url: "https://{{domain}}/projects/new#blank_project"
+
+  codeberg:
+    name: Codeberg
+    domain: codeberg.org
+    default_hosting: codeberg-pages
+    url: "https://{{domain}}/{{user}}/{{projectName}}.git"
+    new_url: "https://codeberg.org/repo/create"
+
+  sourcehut:
+    name: SourceHut
+    domain: git.sr.ht
+    url: "https://{{domain}}/~{{user}}/{{projectName}}.git"
+    new_url: "https://{{domain}}/create"
+
+# --------------------------------------------------------------------------------------
+
+hosting_platforms:
+  github-pages:
+    name: GitHub Pages
+    domain: "github.io"
+    supported_providers: [github] # should be from "vcs_providers" list
+    template_dir: github
+    repo:
+      ideal_name: "{{user}}.github.io"
+      mismatch_msg: |-
+        For automatic GitHub Pages hosting,
+        your repository should be named '{{idealName}}' (exactly your username + .github.io)."
+
+  gitlab-pages:
+    name: GitLab Pages
+    domain: "gitlab.io"
+    supported_providers: [gitlab]
+    template_dir: gitlab
+    repo:
+      ideal_name: "{{user}}.gitlab.io"
+      mismatch_msg: |-
+        As Your project name is not '{{idealName}}',
+        Your site will be available at: https://{{user}}.{{domain}}/{{projectName}}/
+        Instead of: https://{{user}}.{{domain}}/
+    post_setup_tips:
+      - Site will be available once the CI pipeline finishes.
+
+  codeberg-pages:
+    name: Codeberg Pages (Forgejo CI)
+    domain: "codeberg.page"
+    supported_providers: [codeberg]
+    template_dir: codeberg
+    repo:
+      ideal_name: pages
+      mismatch_msg: |-
+        As Your project name is not 'pages',
+        Your site will be available at: https://{{user}}.{{domain}}/{{projectName}}/
+        Instead of: https://{{user}}.{{domain}}/
+    post_setup_tips:
+      - Ensure Codeberg Actions are enabled for your repository.
+      - "Check: Settings > Actions > General > Enable Actions."
+
+  woodpecker:
+    name: Codeberg Pages (Woodpecker CI / Old)
+    domain: "codeberg.page"
+    supported_providers: [codeberg]
+    template_dir: woodpecker
+    repo:
+      ideal_name: pages
+      mismatch_msg: |-
+        As Your project name is not 'pages',
+        Your site will be available at: https://{{user}}.{{domain}}/{{projectName}}/
+        Instead of: https://{{user}}.{{domain}}/
+    post_setup_tips:
+      - Ensure Woodpecker is enabled for your repository.
+      - "Go to https://ci.codeberg.org to enable."
+
+  surge:
+    name: Surge.sh
+    supported_providers: all
+    template_dir:
+      github: surge/github
+      gitlab: surge/gitlab
+      sourcehut: surge/sourcehut
+      codeberg: surge/codeberg
+    repo:
+      ideal_name: "{{user}}.surge.sh"
+    post_setup_tips:
+      - "You must set SURGE_LOGIN and SURGE_TOKEN in your CI/CD Secrets!"
+      - "Your site will be deployed to https://{{user}}.surge.sh"
+
+  netlify:
+    name: Netlify
+    supported_providers: all
+    template_dir: netlify
+    post_setup_tips:
+      - Connect your repository in the Netlify dashboard to deploy automatically.
+      - Then your site will be up once CI finishes.

package/src/templates/static/README.md

@@ -0,0 +1 @@
+Place your static assets (images, files, CNAME) in this directory.

package/src/templates/workflows/codeberg/.forgejo/workflows/deploy.yml

@@ -0,0 +1,39 @@
+name: Deploy Portfolio
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Cache Bun dependencies
+        uses: actions/cache@v5
+        with:
+          path: ~/.bun/install/cache
+          key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}
+          restore-keys: |
+            ${{ runner.os }}-bun-
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Build site
+        run: bunx portosaur build
+
+      - name: Deploy to Codeberg Pages
+        uses: https://codeberg.org/git-pages/action@v2
+        with:
+          site: "https://${{ forge.repository_owner }}.codeberg.page/${{ forge.repository_name }}/"
+          token: ${{ forge.token }}
+          source: build/

package/src/templates/workflows/github/.github/workflows/deploy.yml

@@ -0,0 +1,55 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - "README.md"
+      - ".gitignore"
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v6
+
+      - name: Cache Bun dependencies
+        uses: actions/cache@v5
+        with:
+          path: ~/.bun/install/cache
+          key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}
+          restore-keys: |
+            ${{ runner.os }}-bun-
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Build site
+        run: bun run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: build
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

package/src/templates/workflows/gitlab/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+image: oven/bun:latest
+
+pages:
+  stage: deploy
+  script:
+    - bun install
+    - bunx portosaur build
+    - mv build public
+  artifacts:
+    paths:
+      - public
+  only:
+    - main

package/src/templates/workflows/netlify/netlify.toml

@@ -0,0 +1,6 @@
+[build]
+  command = "bun run build"
+  publish = "build"
+
+[build.environment]
+  BUN_VERSION = "latest"

package/src/templates/workflows/surge/codeberg/.forgejo/workflows/deploy.yml

@@ -0,0 +1,23 @@
+name: Deploy to Surge
+on:
+  push:
+    branches: [main]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Build Docusaurus
+        run: bun run build
+
+      - name: Deploy to Surge
+        run: bunx surge ./build --domain {{projectName}}.surge.sh
+        env:
+          SURGE_LOGIN: ${{ secrets.SURGE_LOGIN }}
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}

package/src/templates/workflows/surge/github/.github/workflows/deploy.yml

@@ -0,0 +1,23 @@
+name: Deploy to Surge
+on:
+  push:
+    branches: [main]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Build Docusaurus
+        run: bun run build
+
+      - name: Deploy to Surge
+        run: bunx surge ./build --domain {{projectName}}.surge.sh
+        env:
+          SURGE_LOGIN: ${{ secrets.SURGE_LOGIN }}
+          SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}

package/src/templates/workflows/surge/gitlab/.gitlab-ci.yml

@@ -0,0 +1,16 @@
+image: oven/bun:latest
+
+stages:
+  - deploy
+
+deploy:
+  stage: deploy
+  only:
+    - main
+  script:
+    - bun install
+    - bun run build
+    - bunx surge ./build --domain {{projectName}}.surge.sh
+  variables:
+    SURGE_LOGIN: $SURGE_LOGIN
+    SURGE_TOKEN: $SURGE_TOKEN

package/src/templates/workflows/surge/sourcehut/.build.yml

@@ -0,0 +1,26 @@
+image: debian/latest
+packages:
+  - curl
+  - git
+sources:
+  - https://git.sr.ht/~{{userName}}/{{projectName}}
+tasks:
+  - setup: |
+      curl -fsSL https://bun.sh/install | bash
+      export PATH=$HOME/.bun/bin:$PATH
+  - install: |
+      export PATH=$HOME/.bun/bin:$PATH
+      cd {{projectName}}
+      bun install
+  - build: |
+      export PATH=$HOME/.bun/bin:$PATH
+      cd {{projectName}}
+      bun run build
+  - deploy: |
+      export PATH=$HOME/.bun/bin:$PATH
+      cd {{projectName}}
+      # Note: SURGE_LOGIN and SURGE_TOKEN must be added to your SourceHut build secrets
+      bunx surge ./build --domain {{projectName}}.surge.sh
+environment:
+  SURGE_LOGIN: ""
+  SURGE_TOKEN: ""

package/src/templates/workflows/woodpecker/.woodpecker/deploy.yml

@@ -0,0 +1,21 @@
+kind: pipeline
+name: deploy
+
+steps:
+  - name: build
+    image: oven/bun:latest
+    commands:
+      - bun install
+      - bunx portosaur build
+
+  - name: deploy
+    image: appleboy/drone-git-push
+    settings:
+      branch: pages
+      remote: git@codeberg.org:${DRONE_REPO}.git
+      force: true
+      commit: true
+      path: build
+    when:
+      event: push
+      branch: main

package/src/utils/git.mjs

@@ -0,0 +1,52 @@
+import { execSync } from "child_process";
+
+/**
+ * Attempts to detect the VCS provider by inspecting the current git repository's remotes.
+ * Matches against the domains defined in the provided registry.
+ *
+ * @param {Object} registry - The Portosaur registry containing vcs_providers.
+ * @returns {string|null} The canonical ID of the detected provider, or null if not found.
+ */
+export function detectVcsProvider(registry) {
+  try {
+    const remotes = execSync("git remote -v", {
+      stdio: "pipe",
+      encoding: "utf8",
+    });
+
+    for (const [id, cfg] of Object.entries(registry.vcs_providers)) {
+      if (remotes.includes(cfg.domain)) {
+        return id;
+      }
+    }
+  } catch {}
+
+  return null;
+}
+
+/**
+ * Retrieves the current git configuration (local and global) as a key-value object.
+ *
+ * @returns {Object} A map of git configuration keys and their values.
+ */
+export function getGitConfig() {
+  const config = {};
+
+  try {
+    const output = execSync("git config --list", {
+      stdio: "pipe",
+      encoding: "utf8",
+    });
+
+    const lines = output.split("\n");
+
+    for (const line of lines) {
+      const [key, ...values] = line.split("=");
+      if (key && values.length > 0) {
+        config[key] = values.join("=");
+      }
+    }
+  } catch {}
+
+  return config;
+}

package/src/utils/index.mjs

@@ -0,0 +1,7 @@
+export * from "./platforms.mjs";
+export * from "./git.mjs";
+export * from "./runner.mjs";
+export * from "./packageManager.mjs";
+export * from "./interaction.mjs";
+export * from "./paths.mjs";
+export * from "./projectName.mjs";