Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/h-enk/hyas-cli
Hyas command line tool
https://github.com/h-enk/hyas-cli
cli hugo hyas
Last synced: 5 days ago
JSON representation
Hyas command line tool
- Host: GitHub
- URL: https://github.com/h-enk/hyas-cli
- Owner: h-enk
- License: mit
- Created: 2020-04-28T10:45:16.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-16T05:01:34.000Z (about 2 years ago)
- Last Synced: 2024-04-25T13:20:50.167Z (10 months ago)
- Topics: cli, hugo, hyas
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@hyas/cli
- Size: 389 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @hyas/cli
[](https://www.npmjs.com/package/@hyas/cli)
[](https://github.com/h-enk/hyas-cli/actions/workflows/codeql-analysis.yml)
Hyas command line tool.
## Installation
Install the [Hyas CLI](https://www.npmjs.com/package/@hyas/cli) globally:
```bash
npm install -g @hyas/cli
```
## npx
Or use [npx](https://nodejs.dev/learn/the-npx-nodejs-package-runner):
```bash
npx @hyas/cli [options]
```
## Usage
```bash
hyas [options]
```
## Commands
### Create
Create a new Hyas project:
```bash
hyas create [dir]
```
| Arguments | Description | Default |
| - | - | - |
| `dir` | Directory to create the project in | `my-hyas-site`|
| `-c, --child` | Use child theme | Use starter theme |
| `-t, --theme` | Hyas theme to use (e.g. `--theme=doks`)| No Hyas theme|
### Start
Start local development server:
```bash
hyas start
```
### Build
Build production website:
```bash
hyas build
```
### Clean
Delete temporary directories:
```bash
hyas clean
```
### Check
Check local environment:
```bash
hyas check
```
## Options
### -h, --help
Show help for command.
### -v, --version
Show @hyas/cli version.
## Documentation
- [Hyas CLI](https://gethyas.com/docs/prologue/hyas-cli/)