https://github.com/anshumanv/boku
A personalised cli scaffolding tool -> npx boku
https://github.com/anshumanv/boku
boku cli scaffolding
Last synced: over 1 year ago
JSON representation
A personalised cli scaffolding tool -> npx boku
- Host: GitHub
- URL: https://github.com/anshumanv/boku
- Owner: anshumanv
- License: mit
- Created: 2018-12-16T04:36:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-18T09:23:11.000Z (over 7 years ago)
- Last Synced: 2025-02-28T16:02:50.303Z (over 1 year ago)
- Topics: boku, cli, scaffolding
- Language: JavaScript
- Homepage:
- Size: 164 KB
- Stars: 13
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
boku
A scaffolding tool to generate personalised cli.
## Demo
Soon!
## Usage
```sh
$ npx boku
//=> Fill your info as per the prompt
//=> Push the generated code somewhere
//=> Publish the module
$ npm publish
//=> Run anywhere!
$ npx username
```
OR
```sh
$ npm i -g boku
$ boku
//=> Push and publish
```
### Image
* Presently the image is fetched from the GitHub API of the provided username.
* To use a custom image from url, simply swap out the image url `avatar_url`.
* To use an image file,
```sh
const path = require('path);
.
.
terminalImage.file(path.join(__dirname, 'image_name.xyz'))
.
.
termImg.file(path.join(__dirname, 'image_name.xyz'), { fallback })
```
## Uses
The handlebars template which is scaffolded out is [here](https://github.com/anshumanv/my-cli-template).
## Thanks
* Amazing [boku no hero academia](https://en.wikipedia.org/wiki/My_Hero_Academia) artwork by [Fazendaaa](https://github.com/Fazendaaa). 🆒
* Template heavily inspired from the [sindresorhus](https://github.com/sindresorhus/sindresorhus) cli. 🙏
## Author
[Anshuman Verma](https://github.com/anshumanv)
[
](https://twitter.com/Anshumaniac12)
[
](https://linkedin.com/in/anshumanv12)
[
](https://www.facebook.com/anshumanv12)
## Contribute
Found a bug? please [create an issue](https://github.com/anshumanv/boku/issues/new)