snapline - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #android #machine-learning #windows #awesome #cli #awesome-list #vue #pytorch #ios #openai #open-source

snapline

(★ 401)

Unleash your screenshots stored in Chrome Devtool timeline files

File Explorer

Download Latest Version (.zip)

- snapline
- convert-to-gif.js
- loading.json
.gitignore
.npmignore
circle.yml
demo.gif
index.js
LICENSE
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/pmdartus/snapline

Downloads the entire project code from GitHub to your computer.

cd snapline

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Node.js Node.js must be installed to use npm.

npm install -g snapline

Installs the package published on the npm registry globally — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install -g snapline

Installs the package published on the npm registry globally — no need to clone the source.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# snapline

[![Circle CI](https://circleci.com/gh/pmdartus/snapline.svg?style=svg)](https://circleci.com/gh/pmdartus/snapline)

> Unleash your screenshots stored in Chrome Devtool timeline files

![demo](https://raw.githubusercontent.com/pmdartus/snapline/master/demo.gif)

## Features

* Convert timeline to gif
* Extract screenshots save in a timeline into a folder

## Install

Before using snapline, please install `imageMagick` and ensure that your version of node is greater than `4.0`.

```shell
npm install -g snapline
```

## CLI usage

```shell
> snapline -h

Usage: snapline <timeline> [options]

Options:
--help        Show help                                              [boolean]
-o, --output  Output file name              [string] [default: "timeline.gif"]
-f, --fps     Number of frames per seconds            [number] [default: "10"]
```

## Node usage

```js
const snapline = require('../src')
const timeline = require('./my-awesome-timeline.json')

snapline.toGif(timeline)
  .then(gifPath => console.log(`The gif(t) is ready: ${gifPath}!`))
```

## API

### `snapline.toGif(timeline[, options])`

* `timeline` <timelineEntry[]> - The parsed JSON content of the timeline file
* `options.output` <String> - path of the gif. default: `./timeline.gif`
* `options.fps` <Number> - Number of frames per seconds. default: `10`

Returns a `Promise` that resolves with the path of the created gif

### `snapline.toImages(timeline[, options])`

* `timeline` <timelineEntry[]> - The parsed JSON content of the timeline file
* `options.output` <String> - folder path that will contains the screenshots. default: `./screenshots`
* `options.fps` <Number> - Number of frames per seconds. default: `10`

Returns a `Promise` that resolves with the path of the path of the created directory

## License

MIT. See `/LICENSE`

## Owner

Pierre-Marie Dartus - [@pmdartus](https://github.com/pmdartus)