artem(1)

💖 NAME 💖

okay so bestie, artem — it converts images from basically every format you've got (jpg, png, webp, etc…) into glorious ASCII art ✨ like, your pic but made of characters. iconic behavior honestly.

🎀 SYNOPSIS 🎀

artem [-c|--characters] [-s|--size] [--height] [-w|--width] [--ratio]
[--flipX] [--flipY] [--centerX] [--centerY] [-o|--output] [--invert]
[--background] [--border] [--no-color] [--outline] [--hysteresis]
[--verbose] [-h|--help] [-V|--version] <INPUT>

🦋 DESCRIPTION 🦋

no cap, that's the whole thing: it takes images from multiple formats (jpg, png, webp, etc…) and turns them into ASCII art. she's a one-trick pony and the trick absolutely ate 💅

🌸 OPTIONS 🌸

• -c, --characters — swaps out which characters get used to draw the image. the first character should be your darkest/densest one and the last should be the lightest (they recommend making it a space ' '). for smaller images, a lower detail map is the move. you can also drop in the included character sets with the argument 0 | 1 | 2. if you pass no characters at all, the default set gets used 🫶
• -s, --size [default: 80] — sets the size of the output image. minimum size is 20, so anything lower gets straight-up ignored and bumped to 20 (rude but fair). heads up: this one conflicts with --width and --height.
• --height — uses your terminal's max height to display the image. conflicts with --size and --width.
• -w, --width — uses your terminal's max width to display the image. conflicts with --size and --height.
• --ratio [default: 0.42] — changes the ratio between height and width, because ASCII characters are a lil taller than they are wide. value has to be between 0.1 and 1.0. ngl they do not recommend messing with this one.
• --flipX — flips the image along the X-axis / horizontally 🪞
• --flipY — flips the image along the Y-axis / vertically 🙃
• --centerX — centers the image along the X-axis / horizontally in the terminal.
• --centerY — centers the image along the Y-axis / vertically in the terminal.
• -o, --output — output file for non-colored ascii. if the output file is a plaintext file, no color gets used. to actually get color, either use a file with an .ansi extension, or an .svg/.html file so the output converts to that respective format. .ansi files will consider environment variables when making colored output — for example, when COLORTERM isn't set to truecolor, the resulting file falls back to 8-bit colors. iykyk 🌈
• --invert — inverts the characters used for the image, so light characters become dark ones. super useful if your image has a dark background 🖤
• --background — sets the background of the ascii to the color. this gets ignored if your terminal doesn't support truecolor, so don't come crying 😭. mutually exclusive with the no-color argument.
• --border — adds a decorative border surrounding the ascii image 🎁. this makes the image overall a bit smaller, since it respects the size you gave it.
• --no-color — do not use color when printing the image to the terminal.
• --outline — only creates an outline of the image. it uses filters, so it'll take more resources/time to finish, especially on larger images 💀. it might not produce the output you wanted, so they advise using this only on images with a clear distinction between foreground and background.
• --hysteresis — when creating the outline, use the hysteresis method, which removes imperfections but might not look as good in ascii form. this requires the --outline argument to be present as well.
• --verbose [default: warn] — picks the verbosity of the logging level. warnings and errors are always shown by default. to completely disable them, use the off argument.

possible values:

• off: do not show logs
• error: only show errors
• warn: show errors and warnings
• info: show info logs
• debug: show debug logs
• trace: show trace logs

• -h, --help — print help (see a summary with '-h') 👑
• -V, --version — print version
• <INPUT> — paths or URLs to the target image. if the input is a URL, the image gets downloaded and then converted. and no, the original image is NOT altered, we're respectful here 💜

⭐ VERSION ⭐

v3.0.0 — she's in her 3.0.0 era.

🧚 AUTHORS 🧚

@FineFindus — the mastermind, the main character, the whole vibe 🫡

so yeah, that's artem from the General Commands Manual (that's artem(1) to the nerds), running version artem 3.0.0. go make some ascii art bestie, slay 💅✨🎀