README.en.md

FixIt CLI

👉 English | 中文

🛠️ A node-based tooling for FixIt site initialization.

System Requirements

• Node.js (>= 18)
• Git
• Hugo extended

If you use the Hugo Modules feature to load the theme, you will also need to install Go.

Usage

It is very convenient to create a new FixIt project by running fixit-cli directly using pnpx or npx. Of course, you can also install fixit-cli globally and use the fixit command.

For example, create a site called my-blog:

pnpx fixit-cli create my-blog

For more usage, please refer to the help information below:

pnpx fixit-cli -h

Usage: fixit <command> [options]

=============================================

        ▄████  ▄█     ▄  ▄█    ▄▄▄▄▀
        █▀   ▀ ██ ▀▄   █ ██ ▀▀▀ █
        █▀▀    ██   █ ▀  ██     █
        █      ▐█  ▄ █   ▐█    █
         █      ▐ █   ▀▄  ▐   ▀
          ▀        ▀
              fixit-cli v1.2.1
         A cli tool for FixIt theme.

=============================================

FixIt is a clean, elegant but advanced blog theme for Hugo
built with love by Lruihao and his friends.

Complete documentation is available at https://fixit.lruihao.cn/.

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

Commands:
  create|new [project-name]  create a new FixIt project/component from a template
  check                      check the latest version of FixIt theme
  help [command]             display help for command

Development

Install dependencies:

pnpm install

Run the CLI in development mode:

pnpm start -h

Link/Unlink the package to/from the global package directory:

pnpm link
pnpm unlink fixit-cli

Install/uninstall the package globally from a local path:

pnpm add -g path/to/fixit-cli
pnpm remove -g fixit-cli

Related Projects

This CLI tool is developed based on the following projects:

• FixIt
• hugo-fixit-starter
• hugo-fixit-starter1
• component-skeleton

Author

Lruihao