/blowfish-tools

CLI to initialize a Blowfish project

Primary LanguageJavaScriptMIT LicenseMIT

Blowfish Tools

GitHub license Node.js Package npm version install size npm downloads

blowfish logo

CLI to initialize and configure a Blowfish project. Install the CLI globally and run blowfish-tools to start the interactive prompt that will walk you through setting up a Blowfish from scratch or configure an existing project.

Features

  • Interactive configuration mode - edit and see changes in real time
  • Create a new Blowfish project from scratch
  • Start a new Blowfish project from one of multiple available templates
  • Configure an existing Hugo project to use Blowfish
  • Update Blowfish to the latest version
  • Configure metadata
  • Configure menu structure
  • Configure overall site
  • Configure site author
  • Configure homepage
  • Configure header
  • Configure footer
  • Configure article pages
  • Configure list pages
  • Configure taxonomy pages
  • Configure term pages
  • Generate empty site sections
  • Generate empty articles
  • Run a local server with Blowfish
  • Generate the static site with Hugo

Installation

Install globally using:

npx blowfish-tools

or

npm install -g blowfish-tools

Interactive run

Start an interactive run with

blowfish-tools

Non-interactive run

Use this package as part of scripts or CI/CD actions

blowfish-tools -h
Usage: blowfish-tools [options] [command]

CLI to initialize and configure a Blowfish project.
Use `blowfish-tools` to start the interactive prompt.
Run `blowfish-tools --help` for more information.

Options:
  -V, --version  output the version number
  -h, --help     display help for command

Commands:
  new <folder>   Creates a new Blowfish project from scratch on the selected folder
  install        Installs Blowfish on an existing Hugo project (assumes current directory).
  update         Update blowfish. Requires Hugo to be installed and Blowfish configured in current
                 directory (via git submodules).
  run            Run a local server with Blowfish in the current directory. Requires Hugo to be
                 installed and Blowfish configured in current directory.
  generate       Generates site assets in public folder in the current directory. Requires Hugo to
                 be installed and Blowfish configured in current directory.
  config         Enter interactive configuration mode. Requires Hugo to be installed and Blowfish
                 configured in current directory.