Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raluvy95/memeinstall
A Node.js CLI for downloading some memes as images and save to a specific directory
https://github.com/raluvy95/memeinstall
cli free generator meme memes node
Last synced: about 1 month ago
JSON representation
A Node.js CLI for downloading some memes as images and save to a specific directory
- Host: GitHub
- URL: https://github.com/raluvy95/memeinstall
- Owner: raluvy95
- License: mit
- Created: 2020-07-02T07:08:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-23T20:43:48.000Z (almost 3 years ago)
- Last Synced: 2024-11-29T21:56:55.656Z (about 2 months ago)
- Topics: cli, free, generator, meme, memes, node
- Language: JavaScript
- Homepage:
- Size: 182 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Meme Installer
A CLI module for downloading memes as images to a specific directory
```
memeinstall [-c ] --directory=
```
# Installation
The module can be install via [npm](https://www.npmjs.com/package/@therealraluvy/memeinstall)
```
npm i -g @therealraluvy/memeinstall
```
If you want to use this for script-only, you can remove the option `-g`. You can check it out in [Script tag](#Script)
```
npm i @therealraluvy/memeinstall
```
# Options
`-c ` | Count of memes to download. The default is 10 and the max almont of memes is 50
`--no-gif=` | Refuse to download GIF meme. Default is false.
`--directory=` | Which folder do you want to download. The default is the current directory.
`--debug` | Enable debug mode. Default is false
# Examples
Without options will install memes in current directory
```
memeinstall
```
This will install 10 memes to a folder called memes
```
memeinstall --directory=memes
```
This will install 50 memes to a folder called memes
```
memeinstall -c 50 --directory=memes
```
# Script
Script support is added in `v1.3.0`. It is similar to CLI, works on Node.js. TypeScript is not supported, but hopefuly will support later
Here's quick example
```js
const memeinstall = require("@therealraluvy/memeinstall")
memeinstall.install()
```
Advanced example
```js
memeinstall.install("memes", 50, true)
.then(() => {
console.log("Finished downloading!")
})
.catch(err => console.error(err))
```
It's possible to get a meme without downloading using `getMeme`
```js
memeinstall.getMeme(25)
.then(json => console.log(json))
```
# Requirements
Node.js >= 10.0.0
Have at least 15 or more MB disk stoarge for 50 memes
# Change Log
### v1.3.0
Fixed `--no-gif` ignoring the check if the file is added
Added Script category
### v1.1.0
Added an optional `--no-gif`. Useful when you want to get memes without GIF.
### v1.0.0-1.0.4
Published to NPM. Nothing changes