A CLI to bootstrap new projects!
Hyper is a CLI that helps U generate an Advanced Project Template in seconds.
Prerequisites
Node.js and npm are required as a peer dependency.
Installing
npm install -g @sharksv/hyper
// or
yarn global add @sharksv/hyper
alternatively:
npx @sharksv/hyper <command> [options]
Compile from source
$ git clone https://github.com/iTzSharkSV/Hyper.git
$ cd Hyper
$ npm install // install project dependencies
$ npm run build // compile project
$ npm i -g . // add as a global variable
Usage/Examples
@example: Help info
$ hyper help
---------------------------------------------------------
Hyper v3.0 by @Shorky
A CLI to bootstrap new projects!
USAGE:
$ hyper <commands> [options]
COMMANDS:
help Prints usage-help info
init Initialize a new project
list List available templates
OPTIONS:
-k, --keep Keep terminal output (off by Default)
-y, --skip Generate without prompt
-i, --install Install project dependencies
-v, --version Prints CLI version (following semver)
@example: Initializing a project
$ hyper init -y
-------------------
// prompt skipped (-y, --skip)
some magic goes here,
& some here...
voila!
The Why?
Why use Hyper-CLI instead of starting-fresh?
-------------------------------------------------------
- Faster
- Easier
- Up-with Community Standards
- Besides being Well-Put & Organized
Why not just use a template?
------------------------------------
Orignally, starting-fresh or using a template was my-go-2 option, but...
The time wasted looking for a generic, minimalistic yet well-put template
-for every project I wanted to start was a bit too much.
Here aroused the motivation to create `Hyper`.
Hyper is a CLI that helps U bootstrap new projects!
Available Templates
$ hyper list
---------------------------------------------------------
LANGUAGE Size(kb) NAME
---------------------------------------------------------
(-) 37.5 Jumpstart
Ts/Sass 41.0 Static-Web
Typescript 40.1 Node Project
Rust-Lang 38.1 Rust Project
Java - Java Project (Coming soon)
---------------------------------------------------------
Sample Project Tree
π¦ <Node Project>
ββ .circleci
β ββ config.yml
ββ .github
β ββ ISSUE_TEMPLATE
β β ββ BUG_REPORT.md
β β ββ FEATURE_REQUEST.md
β ββ workflows
β β ββ CodeQL.yml
β ββ PULL_REQUEST_TEMPLATE.md
ββ .husky
β ββ pre-commit
ββ Docs
β ββ CODE_OF_CONDUCT.md
β ββ CONTRIBUTING.md
β ββ SECURITY.md
ββ Src
β ββ Modules
β β ββ Something.ts
β β ββ Another.ts
β ββ index.ts
ββ Tests
β ββ Unit.test.ts
ββ .gitignore
ββ .eslintrc # Available within package.json
ββ .prettierrc # Available within package.json
ββ Dockerfile
ββ CHANGELOG.md
ββ README.md
ββ package.json
ββ tsconfig.json
ββ LICENSE
License
#
# Copyright 2021 @SharkSV
# License Identifier: MIT
#