https://github.com/bramkok/boil
Scaffolding tool
https://github.com/bramkok/boil
bash scaffold-framework
Last synced: 2 months ago
JSON representation
Scaffolding tool
- Host: GitHub
- URL: https://github.com/bramkok/boil
- Owner: bramkok
- License: mit
- Created: 2016-06-18T18:58:55.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-09-16T07:33:22.000Z (almost 8 years ago)
- Last Synced: 2025-06-26T02:42:10.026Z (about 1 year ago)
- Topics: bash, scaffold-framework
- Language: Shell
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# boil
> Simple scaffolding
## Usage:
```
$ boil [--option ]
```
### Options
##### `-h`, `--help`
Display help information.
##### `-b`, `--boilerplate` **[REQUIRED]**
Choose a boilerplate hosted on GitHub. Input format:
`--boilerplate username/repository`
* Bash [`bramkok/boilerplate-bash`](https://github.com/bramkok/boilerplate-bash)
* ECMAScript 2015 [`bramkok/boilerplate-es2015`](https://github.com/bramkok/boilerplate-es2015)
##### `-n`, `--name` **[REQUIRED]**
Pick a name for the project.
##### `-d`, `--description`
Description of the project.
##### `-a`, `--author`
Name of the project's author.
##### `-u`, `--username`
GitHub username.
##### `-p`, `--path`
Target path of the project.
### Testing
Use [Bats](https://github.com/sstephenson/bats) (Bash Automated Testing System)
for testing. The Bats testing file for `boil` can be found in the '/test'
directory.
#### Usage
```
$ bats test/boil.bats
```
## License
MIT © [Bram Kok](https://bramkok.com)