import Image from "next/image";
import cup from "@/app/assets/cup.gif";
import { Cards } from "nextra/components";
import { IconBrandDocker, IconPackage } from "@tabler/icons-react";

# Introduction

<Image src={cup} alt="Animated GIF of Cup's CLI in action" unoptimized />

Cup is a lightweight alternative to [What's up Docker?](https://github.com/getwud/wud) written in Rust.

# Features ✨

- 🚀 Extremely fast. Cup takes full advantage of your CPU and is hightly optimized, resulting in lightning fast speed. On my Raspberry Pi 5, it took 3.7 seconds for 58 images!
- Supports most registries, including Docker Hub, ghcr.io, Quay, lscr.io and even Gitea (or derivatives)
- Doesn't exhaust any rate limits. This is the original reason I created Cup. It was inspired by [What's up docker?](https://github.com/getwud/wud) which would always use it up.
- Beautiful CLI and web interface for checking on your containers any time.
- The binary is tiny! At the time of writing it's just 5.4 MB. No more pulling 100+ MB docker images for a such a simple program.
- JSON output for both the CLI and web interface so you can connect Cup to integrations. It's easy to parse and makes webhooks and pretty dashboards simple to set up!

# Installation

<Cards>
  <Cards.Card
    icon={<IconBrandDocker />}
    title="With Docker"
    href="/docs/installation/docker"
  />
  <Cards.Card
    icon={<IconPackage />}
    title="As a binary"
    href="/docs/installation/binary"
  />
</Cards>
