Menyoki

<p align="center"> <a href="https://github.com/orhun/menyoki"> <img src="https://user-images.githubusercontent.com/24392180/98470768-09356680-21f9-11eb-81de-94a622b32db4.png" width="500"></a> <br> <b>Screen{shot,cast} and perform ImageOps on the command line 🌱 🏞️</b> <br> <br> <a href="https://github.com/orhun/menyoki/releases"> <img src="https://img.shields.io/github/v/release/orhun/menyoki?style=flat&labelColor=000000&color=25691f&logo=GitHub&logoColor=white"> </a> <a href="https://crates.io/crates/menyoki/"> <img src="https://img.shields.io/crates/v/menyoki?style=flat&labelColor=000000&color=25691f&logo=Rust&logoColor=white"> </a> <a href="https://archlinux.org/packages/extra/x86_64/menyoki/"> <img src="https://img.shields.io/archlinux/v/extra/x86_64/menyoki?style=flat&labelColor=000000&color=25691f&logo=Arch%20Linux&logoColor=white"> </a> <br> <a href="https://github.com/orhun/menyoki/actions?query=workflow%3A%22Continuous+Integration%22"> <img src="https://img.shields.io/github/actions/workflow/status/orhun/menyoki/ci.yml?branch=master&style=flat&labelColor=000000&color=25691f&label=CI&logo=GitHub%20Actions&logoColor=white"> </a> <a href="https://github.com/orhun/menyoki/actions?query=workflow%3A%22Continuous+Deployment%22"> <img src="https://img.shields.io/github/actions/workflow/status/orhun/menyoki/cd.yml?style=flat&labelColor=000000&color=25691f&label=CD&logo=GitHub%20Actions&logoColor=white"> </a> <a href="https://hub.docker.com/r/orhunp/menyoki"> <img src="https://img.shields.io/github/actions/workflow/status/orhun/menyoki/docker.yml?style=flat&labelColor=000000&color=25691f&label=Docker&logo=Docker&logoColor=white"> </a> <a href="https://codecov.io/gh/orhun/menyoki"> <img src="https://img.shields.io/codecov/c/gh/orhun/menyoki?style=flat&labelColor=000000&color=25691f&logo=Codecov&logoColor=white"> </a> </p>

menyoki is a screencast and screenshot utility that can also perform various image related operations such as making/splitting GIFs and modifying/analyzing/viewing image files. It aims to be a lightweight command line tool for either helping out on day-to-day life operations or complicated detail-centric issues. Originally it was designed to record/screenshot terminal windows but it can be tweaked easily for other purposes with command line arguments, environment variables, or a configuration file.

<details> <summary>Table of Contents</summary>

• Supported Platforms
• Supported Formats
• Installation
  • Requirements
  • Cargo
  • Arch Linux
  • Docker
    • Docker Hub
    • Building an image
  • Manual
    • From source
    • Releases
• Features
• Usage
  • General
    • Arguments
    • Examples
  • Record
    • Arguments
    • Examples
    • Pro Tip
  • Split
    • Arguments
    • Examples
  • Make
    • Arguments
    • Examples
  • Capture
    • Arguments
    • Examples
  • Edit
    • Arguments
    • Examples
  • Analyze
    • Arguments
    • Examples
  • View
    • Arguments
    • Examples
  • Other
    • GIF/APNG
    • PNG
    • JPG
    • WEBP
    • PNM
    • Save
• Key Bindings
• Configuration
• Environment Variables
  • Examples
• Roadmap
  • Accessibility
  • Platforms
  • Formats
  • Optimization
  • Testing
• Resources
  • About the project
  • Why "menyoki"?
  • Social Media
  • Funding
• License
• Copyright

</details>

Supported Platforms

• [x] Linux
  • [x] X11 (fully supported)
  • [ ] Wayland (no record/capture)
• [ ] Windows (no record/capture)
• [ ] macOS (no record/capture)

menyoki requires a window system implementation of the supported platform for record and capture actions. Other features are expected to work normally since they don't require a window system running (or grabbing a window to operate on). For example, despite the macOS is not listed as a supported platform, menyoki still can perform image operations such as edit, analyze and view if it's compiled on macOS.

Supported Formats

• [x] GIF
• [x] APNG
• [x] PNG
• [x] JPEG
• [x] BMP
• [x] ICO
• [x] TIFF
• [x] PNM
• [x] TGA
• [x] farbfeld
• [x] OpenEXR
• [x] WebP
• [ ] AVIF
• [ ] MP4

Installation

Requirements

• Rust: 1.56.1+
• Dependencies
  • Arch Linux: libx11, libxrandr
  • Debian, Ubuntu: libx11-dev/librust-x11-dev, libxrandr-dev
  • Fedora: libX11-devel, libXrandr

Cargo

menyoki can be installed from crates.io using cargo if Rust is installed.

cargo install menyoki

Use --force option to update.

cargo install menyoki --force

Arch Linux

menyoki can be installed from the Arch Linux extra repository.

pacman -S menyoki

Or if you prefer, you can use an available AUR package for installation.

• Use an AUR helper:

paru menyoki

• Clone the package and compile it with makepkg:

git clone https://aur.archlinux.org/menyoki-git.git
cd menyoki-git
makepkg -si

Docker

Docker Hub

Download the orhunp/menyoki image from Docker Hub (see available tags):

docker pull orhunp/menyoki:<tag>

Run a container:

docker run orhunp/menyoki:<tag>

Building an image

After cloning the repository, you can build an image from Dockerfile:

docker build -t menyoki .

Then you can either run a container:

docker run menyoki

or spawn a shell inside the container with running it interactively:

docker run -it menyoki /bin/bash

Manual

From source

1. Clone the repository.

git clone https://github.com/orhun/menyoki.git && cd menyoki/

2. Build the project and install binary.

cargo install --path .

Releases

1. Download the latest archive from releases page and extract it.
2. Move menyoki binary to /usr/local/bin/ (Linux)

Features

• Record an animation
• Split an animation into frames
• Make an animation from frames
• Capture an image
• Edit an image
• Analyze an image
• View an image

Usage

<table> <tr> <th>Action</th> <td><img src="https://user-images.githubusercontent.com/24392180/99543947-cdeb2280-29c4-11eb-87a9-ad559f9522ad.gif"></td> </tr> <tr> <th>Result</th> <td><img src="https://user-images.githubusercontent.com/24392180/99814600-3cadb480-2b5a-11eb-84ce-1a693d5ddc2c.gif"></td> </tr> </table>

Command line arguments of menyoki are designed to be as intuitive as possible. As a result of that, an action can be performed with a chain of subcommands along with the flags and options. The general prototype for the usage of command line arguments is the following:

menyoki (ACTION) (FORMAT) (OUTPUT)

The subcommand that will indicate the action is mandatory whereas format and output subcommands might be optional (or they might not exist at all). The format subcommand can be one of the supported formats and output basically corresponds to the save subcommand.

The default format is the first listed subcommand if there is not any subcommand given for specifying a format. On the other hand, save subcommand uses the "menyoki" directory in the home (or images if it exists) as the default output directory.

General <a href="https://github.com/orhun/menyoki"><img src="https://user-images.githubusercontent.com/24392180/99184076-96c10b00-2751-11eb-99ea-ad962144df76.png" height="30"></a>

Flags and options that will generally affect the execution of menyoki can be set before specifying the main action to perform. Then the main subcommand