# Stitchy CLI

![example workflow](https://github.com/grimace87/Stitchy/actions/workflows/cargo.yml/badge.svg)
[![Crates.io](https://img.shields.io/crates/v/stitchy.svg)](https://crates.io/crates/stitchy)

CLI tool which wraps the features of the
[stitchy-core](https://github.com/grimace87/Stitchy/tree/master/crates/stitchy-core) crate, adding configuration
capabilities using command-line arguments and profile defaults, and adding file output.

See the [root project overview](https://github.com/grimace87/Stitchy) for an
overview of the Stitchy ecosystem.

## Installing

Rust version 1.63 or later is required.

- [Install the Rust programming language](https://www.rust-lang.org/tools/install) if you don't 
  already have it; this will include the `cargo` tool by default
- Run `cargo install stitchy`

That's it! The binary will be built from source and then become available in a command line.
If you installed Cargo with default settings, binaries will be in the `.cargo/bin` directory
inside your home directory, which will be available on your PATH.

### NetBSD

If you are using NetBSD, `stitchy` is available from the official repositories. To install the
binary package, simply run:

```sh
pkgin install stitchy
```

## Running

The simplest case takes a given number of image files from the current directory and stitches
them using sensible configuration defaults:

`stitchy n`

where `n` is the number of images you would like to stitch together into one. The tool
will take the `n` most recent files and arrange them in a file named "stitch".

Various flags exist to adjust how source images are selected and how the output is generated.
Run `stitchy --help` to see a list of these flags.

## Configuration

For the full list of configuration options, run `stitchy --help`. Some options are:
- Set the desired output format using `--png`, `--jpeg`, `--gif` or `--bmp`; for JPEG a
  quality option (0 to 100) can be passed like `--quality=___`
- Set a limit on one output dimension using `--maxh=___` or `--maxw=___`, or both using
  `--maxd=___`

## Saving Defaults

Defaults can be saved to a file `.stitchyrc` in your home directory. Whenever you run `stitchy`,
these defaults are applied, unless you override them in the current command.

- Save default options using the flag `--setdefaults` and the options you want to save - though
  do not pass a number of images - and a stitch operation will not take place but rather the
  defaults file will be written using the other arguments supplied
- Clear the defaults by running `stitchy --cleardefaults`
- Check the current defaults by running `stitchy --printdefaults`; this has the same effect as
  printing the contents of the `.stitchyrc` file to the terminal.