Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nunocoracao/blowfish-tools

CLI to initialize a Blowfish project
https://github.com/nunocoracao/blowfish-tools

blowfish hugo npm

Last synced: 11 days ago
JSON representation

CLI to initialize a Blowfish project

Host: GitHub
URL: https://github.com/nunocoracao/blowfish-tools
Owner: nunocoracao
License: mit
Created: 2024-01-13T17:50:45.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-08-28T16:05:45.000Z (2 months ago)
Last Synced: 2024-10-12T22:34:04.578Z (25 days ago)
Topics: blowfish, hugo, npm
Language: JavaScript
Homepage: https://blowfish.page
Size: 655 KB
Stars: 14
Watchers: 2
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# [Blowfish Tools](https://blowfish.page/)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nunocoracao/blowfish-tools/blob/main/LICENSE)
[![Node.js Package](https://github.com/nunocoracao/blowfish-tools/actions/workflows/release-package.yml/badge.svg)](https://github.com/nunocoracao/blowfish-tools/actions/workflows/release-package.yml)
[![npm version](https://img.shields.io/npm/v/blowfish-tools.svg?style=flat-square)](https://www.npmjs.org/package/blowfish-tools)
[![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=blowfish-tools&query=$.install.pretty&label=install%20size&style=flat-square)](https://packagephobia.now.sh/result?p=blowfish-tools)
[![npm downloads](https://img.shields.io/npm/dm/blowfish-tools.svg?style=flat-square)](https://npm-stat.com/charts.html?package=blowfish-tools)

![blowfish logo](https://github.com/nunocoracao/blowfish-tools/blob/main/banner.png?raw=true)

CLI to initialize and configure a [Blowfish](https://blowfish.page) 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:

```bash
npx blowfish-tools
```
or

```bash
npm install -g blowfish-tools
```

## Interactive run

Start an interactive run with

```bash
blowfish-tools
```

## Non-interactive run

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

```bash
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 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.
```