snippeteer/README.md

43 lines
653 B
Markdown
Raw Normal View History

2020-01-15 14:52:31 +01:00
# Snippeteer
## Installation
2020-01-15 14:56:36 +01:00
to work with the @scode scope you have to add the following line to your npmrc.
2020-01-15 14:52:31 +01:00
for this particular one you'll have to add it to the global npmrc stored in your home folder (~/.npmrc)
```npmrc
@scode:registry=https://npm.scode.ovh
```
then install the module using the following command
```sh
npm i -g @scode/snippeteer
```
## Usage
2020-01-15 14:54:57 +01:00
```sh
2020-01-15 14:52:31 +01:00
snippeteer [snippet] [..args]
```
All snippets will be executed relative to your current working directory!
## Snippets
### Snippet
Creates a new snippet template
```sh
snippeteer snippet [name]
```
2020-01-15 20:56:47 +01:00
### Node
Creates a new nodejs project
```sh
snippeteer node [name]
```