https://github.com/echobind/eb-scripts
Echobind's scripts
https://github.com/echobind/eb-scripts
cli node oclif scripts typescript
Last synced: about 1 month ago
JSON representation
Echobind's scripts
- Host: GitHub
- URL: https://github.com/echobind/eb-scripts
- Owner: echobind
- License: mit
- Created: 2019-10-29T16:11:49.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T23:43:06.000Z (over 3 years ago)
- Last Synced: 2026-02-04T07:27:57.610Z (4 months ago)
- Topics: cli, node, oclif, scripts, typescript
- Language: TypeScript
- Size: 30.5 MB
- Stars: 1
- Watchers: 11
- Forks: 0
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# eb-scripts
[](#contributors)
A CLI and scripts used at Echobind
[](https://oclif.io)
[](https://npmjs.org/package/eb-scripts)
[](https://npmjs.org/package/eb-scripts)
[](https://github.com/echobind/eb-scripts/blob/master/package.json)
* [eb-scripts](#eb-scripts)
* [Quickstart](#quickstart)
* [Usage](#usage)
* [Commands](#commands)
* [Contributing](#contributing)
# Quickstart
To get started quickly, from the root of your project run:
```shell
npx eb-scripts init (react|react-typescript|react-native-typescript)
```
This will install `eb-scripts` as a `devDependency` and add a few helpful `hygen` scripts to your `package.json`.
# Usage
```sh-session
$ npm install -g eb-scripts
$ eb-scripts COMMAND
running command...
$ eb-scripts (-v|--version|version)
eb-scripts/2.0.6 linux-x64 node-v13.1.0
$ eb-scripts --help [COMMAND]
USAGE
$ eb-scripts COMMAND
...
```
# Commands
* [`eb-scripts generate TEMPLATENAME`](#eb-scripts-generate-templatename)
* [`eb-scripts help [COMMAND]`](#eb-scripts-help-command)
* [`eb-scripts init PROJECT`](#eb-scripts-init-project)
## `eb-scripts generate TEMPLATENAME`
generates new files
```
USAGE
$ eb-scripts generate TEMPLATENAME
ARGUMENTS
TEMPLATENAME (react-component|react-typescript-component|react-native-typescript-component|react-native-typescript-sc
reen|react-native-e2e|util-typescript) the template you want to use
OPTIONS
-h, --help show CLI help
-n, --name=name [default: MyNewComponent] name to print
-p, --path=path path to where you want the files to go
EXAMPLE
$ eb-scripts generate react-component -n MyNewComponent -p src/components
Loaded templates: _templates
added: src/MyNewComponent.js
```
_See code: [src/commands/generate.ts](https://github.com/echobind/eb-scripts/blob/v2.0.6/src/commands/generate.ts)_
## `eb-scripts help [COMMAND]`
display help for eb-scripts
```
USAGE
$ eb-scripts help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.1/src/commands/help.ts)_
## `eb-scripts init PROJECT`
initializes project by installing `eb-scripts` and adding scripts to `package.json`
```
USAGE
$ eb-scripts init PROJECT
ARGUMENTS
PROJECT (react|react-typescript|react-native-typescript) The language or framework of the project.
Valid options: react,react-typescript,react-native-typescript
OPTIONS
-h, --help show CLI help
EXAMPLE
$ npx eb-scripts init react
```
_See code: [src/commands/init.ts](https://github.com/echobind/eb-scripts/blob/v2.0.6/src/commands/init.ts)_
# Contributing
If you're interested in contributing, please read our [CONTRIBUTING](https://github.com/echobind/eb-scripts/blob/master/CONTRIBUTING.md) guide.
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
JavaScript Joe
💻 📖 💡 🚧
Jenn
👀 💻
Alvin Crespo
💻 📖 ⚠️ 👀
Chris Ball
🚇 🤔 👀
Jeffrey Zhen
👀
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!