https://github.com/pichillilorenzo/gifski-command

Node.js module for gifski GIF encoder CLI
https://github.com/pichillilorenzo/gifski-command

converter encoder ffmpeg gif gif-encoder gifski gifski-cli gifski-encoder gifski-gif javascript js node nodejs png server video

Last synced: 18 days ago
JSON representation

Node.js module for gifski GIF encoder CLI

• Host: GitHub
• URL: https://github.com/pichillilorenzo/gifski-command
• Owner: pichillilorenzo
• License: isc
• Created: 2022-09-30T00:40:11.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-11T20:46:41.000Z (about 2 years ago)
• Last Synced: 2024-10-02T10:21:17.319Z (about 1 month ago)
• Topics: converter, encoder, ffmpeg, gif, gif-encoder, gifski, gifski-cli, gifski-encoder, gifski-gif, javascript, js, node, nodejs, png, server, video
• Language: TypeScript
• Homepage: https://pichillilorenzo.github.io/gifski-command/
• Size: 1.19 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


# Gifski Command

### Node.js module for [gifski](https://github.com/ImageOptim/gifski) GIF encoder CLI

[![NPM](https://nodei.co/npm/gifski-command.png?compact=true)](https://nodei.co/npm/gifski-command/)




[![](https://img.shields.io/npm/dt/gifski-command.svg?style=flat-square)](https://www.npmjs.com/package/gifski-command)



[![NPM Version](https://badgen.net/npm/v/gifski-command)](https://npmjs.org/package/gifski-command)

[![Coverage Status](https://coveralls.io/repos/github/pichillilorenzo/gifski-command/badge.svg?branch=main)](https://coveralls.io/github/pichillilorenzo/gifski-command?branch=main)

[![license](https://img.shields.io/github/license/pichillilorenzo/gifski-command)](/LICENSE)

[![Donate to this project using Paypal](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.me/LorenzoPichilli)

## Getting started

To get started with this library, you need to install it and add it to your project.

### Installation

```bash

# npm

npm install gifski-command --save

# yarn

yarn add gifski-command

```

## Library Usage

API Reference available at [https://pichillilorenzo.github.io/gifski-command/](https://pichillilorenzo.github.io/gifski-command/).

```javascript

import * as path from 'path';

import {GifskiCommand} from 'gifski-command';

// or

const path = require('path');

const {GifskiCommand} = require('gifski-command');

const command = new GifskiCommand({

  output: path.join(__dirname, 'test', 'video.gif'),

  frames: [ path.join(__dirname, 'test', 'video.mp4.frame*.png') ],

  quality: 100

});

command.on('progress', progress => {

  console.log(progress);

});

const result = await command.run();

```

## CLI Usage

- `` represents a [glob pattern](https://www.npmjs.com/package/glob) used to specify PNG frames used by [gifski](https://github.com/ImageOptim/gifski). Surround the glob pattern with quotes (example `'./test/**/*.png'`).

- `[options]` are the same as the [gifski](https://github.com/ImageOptim/gifski) CLI options.

```

Usage: gifski-command [options] 

Examples: 

  gifski-command -Q 100 -o './test/video.gif' './test/**/video.mp4.frame*.png'

  gifski-command -o - './test/**/video.mp4.frame*.png' > './test/video.gif'

Arguments:

  pattern                Glob pattern of PNG image files. Surround the glob pattern with quotes (example './test/**/*.png').

Options:

  -o, --output    Destination file to write to; "-" means stdout

  -r, --fps         Frame rate of animation. This means the speed, as all frames are kept. [default: 20]

  --fast                 50% faster encoding, but 10% worse quality and larger file size

  --extra                50% slower encoding, but 1% better quality

  -Q, --quality <1-100>  Lower quality may give smaller file [default: 90]

  -W, --width        Maximum width. By default anims are limited to about 800x600

  -H, --height       Maximum height (stretches if the width is also set)

  --no-sort              Use files exactly in the order given, rather than sorted

  -q, --quiet            Do not display anything on standard output/console

  --repeat          Number of times the animation is repeated (-1 none, 0 forever or  repetitions)

  -h, --help             display help for command

```

## CLI Usage Example

The recommended way is to first export video as PNG frames. If you have [ffmpeg](https://ffmpeg.org/) installed, you can run in terminal:

```bash

ffmpeg -i ./test/video.mp4 ./test/video.mp4.frame%04d.png

```

and then make the GIF from the frames:

```bash

gifski-command -Q 100 -o './test/video.gif' './test/**/video.mp4.frame*.png'

```

This code snippet shows how to put into action `gifski-command` to convert video frames into a high quality GIF using the [gifski](https://github.com/ImageOptim/gifski) encoder.

## Contributors

Any contribution is appreciated. You can get started with the steps below:

1. Fork [this repository](https://github.com/pichillilorenzo/gifski-command) (learn how to do this [here](https://help.github.com/articles/fork-a-repo)).

2. Clone the forked repository.

3. Make your changes and create a pull request ([learn how to do this](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)).

4. I will attend to your pull request and provide some feedback.

## License

This repository is licensed under the [ISC](LICENSE) License.