LinuxCommandLibrary

finch

Build, run, and manage container images

TLDR

Launch finch

$ finch
copy

Quit
$ [<Alt q>|<Ctrl c>]
copy

Show actions menu
$ <Alt a>
copy

Jump to n-th window
$ <Alt [Number]>
copy

Close current window
$ <Alt c>
copy

Start moving a window, use to move, press when done
$ <Alt m>
copy

Start resizing a window, use to resize, press when done
$ <Alt r>
copy

SYNOPSIS

finch [command] [options]

PARAMETERS

build
    Build an image from a Dockerfile.

containerd
    Manage containerd settings.

context
    Manage contexts.

help
    Show help for a command.

images
    List images.

init
    Initialize Finch.

login
    Log in to a container registry.

logout
    Log out from a container registry.

pull
    Pull an image from a registry.

push
    Push an image to a registry.

run
    Run a command in a new container.

tag
    Create a tag NAME referencing IMAGE.

version
    Show the Finch version information.

DESCRIPTION

Finch is a command-line tool designed to simplify the process of running and managing containerized applications on macOS. It aims to provide a seamless developer experience by abstracting away the complexities of containerization. Finch leverages virtualization technology (like containerd and lima) to create lightweight Linux environments on macOS, allowing developers to build, test, and run containers without needing a full-fledged virtual machine or relying on remote servers. It offers a familiar command-line interface, similar to Docker, making it easy to adopt for those already familiar with container workflows.

Finch's key features include automated setup and configuration of the necessary components, support for container images from various registries, and the ability to manage container networking and storage. The primary goal of Finch is to enable local container development, facilitating faster iteration cycles and improving developer productivity. It's especially useful for developers who prefer a lightweight and streamlined containerization solution specific to macOS.

CAVEATS

Finch is primarily designed for macOS. Its reliance on virtualization means it may not perform as efficiently as native Linux environments. Resource usage can also vary depending on the configuration and the complexity of the containerized applications being run.

INSTALLATION

Finch can be installed using brew: `brew install finch`. Make sure you have brew installed on your machine before running that command.

CONFIGURATION

Finch stores the lima instance inside `~/.finch`. You can configure lima instance (e.g. disk space) before calling `finch init`.

HISTORY

Finch is a relatively new tool, born from the need for a more streamlined container development experience on macOS. Its development is driven by the desire to provide a lightweight alternative to heavier containerization solutions while still offering compatibility with existing container workflows. It is designed with a CLI similar to docker to make it easy to switch from docker to finch.

The tool is under active development to improve functionality and address potential limitations. The initial focus has been on simplifying the setup and management of containers, allowing users to quickly get started with containerized applications on their macOS machines.

SEE ALSO

docker(1), podman(1)

Copied to clipboard