CLI Quick Start Guide

Create a new HugoBlox project locally using the command line (CLI). Step-by-step install guide for Windows, Mac, and Linux.

For developers and data scientists who prefer working locally, our CLI tool creates a new project with all the best practices set up.

Prerequisites

To build locally, you need to install Hugo and its dependencies.

Core Requirements

  • Node.js (version 18 or higher)
  • Git
  • Go
  • Hugo Extended (The "Extended" version is required)

Install Guide

We recommend using Winget (Windows Package Manager), which comes pre-installed on Windows 10 and 11.

Open PowerShell or Terminal and run:

winget install OpenJS.NodeJS.LTS Git.Git GoLang.Go Hugo.Hugo.Extended

You may need to restart your terminal after installation for the tools to be recognized.

Open Terminal and install Homebrew:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Install Hugo Extended and dependencies:

brew install git golang hugo node

For Debian/Ubuntu, install all prerequisites (including Hugo Extended) via Snap:

sudo snap install --classic go node hugo

For other Linux distributions, follow the official Hugo documentation: Install from repository packages.

For installation issues, check the Hugo Community Forum.

Quick Start

Once prerequisites are installed, creating a site takes seconds.

🚚 Already have a HugoBlox site in GitHub? Import it instead of running Steps 1–2:

git clone <github_repo_url> my-site
cd my-site
npm install -g hugoblox
hugoblox dev

The my-site suffix keeps your folder name consistent with the rest of this guide—swap it for any folder name you prefer.

Then jump to Step 3 to start your local server.

  1. Create your Site

    Open your terminal and create a new site:

    npm install -g hugoblox
    hugoblox create site

    Pro Tip: You can use hbx as a shortcut alias for the hugoblox command (e.g. hbx create site).

    View the full CLI Reference.

  2. Follow the Prompts

    The CLI will ask you:

    • What type of site you want to build (e.g., Academic, Blog, Landing Page)
    • Where to create the folder
  3. Start the Local Server

    The CLI will ask if you want to start the local server to preview your site.

    Your site will be available at http://localhost:1313 (or similar port).

  4. Customize with Ownable CMS

    Open your new project folder in VS Code.

    Install the Ownable CMS extension to visually configure your site without editing YAML files.

  5. Deploy

    Push to GitHub to auto-deploy to GitHub Pages or deploy to an alternative host.

Next Steps


🙋 Installation Troubleshooting & FAQ

Was this page helpful?

From the makers of

© 2026 Lore Labs.

On this page