https://github.com/hugo-fixit/fixit-cli
π οΈ A node-based tooling for FixIt site initialization.
https://github.com/hugo-fixit/fixit-cli
fixit fixit-cli hugo hugo-theme-fixit nodejs scaffolding-tool
Last synced: 2 months ago
JSON representation
π οΈ A node-based tooling for FixIt site initialization.
- Host: GitHub
- URL: https://github.com/hugo-fixit/fixit-cli
- Owner: hugo-fixit
- License: mit
- Created: 2023-11-20T06:40:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-08T12:24:32.000Z (8 months ago)
- Last Synced: 2024-09-28T05:41:10.234Z (7 months ago)
- Topics: fixit, fixit-cli, hugo, hugo-theme-fixit, nodejs, scaffolding-tool
- Language: JavaScript
- Homepage:
- Size: 57.6 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.en.md
- License: LICENSE
Awesome Lists containing this project
README
# FixIt CLI
[](https://www.npmjs.com/package/fixit-cli)
π English | [δΈζ](README.md)
π οΈ A node-based tooling for [FixIt](https://github.com/hugo-fixit/FixIt) site initialization.
[](https://asciinema.org/a/697494)
## System Requirements
- [Node.js](https://nodejs.org/) (>= 18)
- [Git](https://git-scm.com/)
- [Hugo](https://gohugo.io/) extended
If you use the [Hugo Modules](https://gohugo.io/hugo-modules/) feature to load the theme, you will also need to install [Go](https://go.dev/dl/).
## Usage
It is very convenient to create a new FixIt project by running `fixit-cli` directly using [`pnpx`](https://pnpm.io/cli/dlx) or [`npx`](https://docs.npmjs.com/cli/v11/commands/npx). Of course, you can also install `fixit-cli` globally and use the `fixit` command.
For example, create a site called `my-blog`:
```bash
pnpx fixit-cli create my-blog
```
For more usage, please refer to the help information below:
```bash
pnpx fixit-cli -h
```
```plain
Usage: fixit [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:
```bash
pnpm install
```
Run the CLI in development mode:
```bash
pnpm start -h
```
Link/Unlink the package to/from the global package directory:
```bash
pnpm link
pnpm unlink fixit-cli
```
Install/uninstall the package globally from a local path:
```bash
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](https://github.com/hugo-fixit/FixIt)
- [hugo-fixit-starter](https://github.com/hugo-fixit/hugo-fixit-starter)
- [hugo-fixit-starter1](https://github.com/hugo-fixit/hugo-fixit-starter1)
- [component-skeleton](https://github.com/hugo-fixit/component-skeleton)
## Author
[Lruihao](https://github.com/Lruihao "Follow me on GitHub")