CLI QUICKSTART

ARR from the Terminal

Set up once, then drag & drop or batch attest as much as you want.

  █████╗   ██████╗   ██████╗
 ██╔══██╗  ██╔══██╗  ██╔══██╗
 ███████║  ██████╔╝  ██████╔╝
 ██╔══██║  ██╔══██╗  ██╔══██╗
 ██║  ██║  ██║  ██║  ██║  ██║
 ╚═╝  ╚═╝  ╚═╝  ╚═╝  ╚═╝  ╚═╝

arr init   # guided setup
arr watch  # drag & drop inbox

Install

# Install the CLI
npm install -g @allrightsrespected/cli@latest

One-time Setup

arr init asks a few questions once (creator ID, default tool, intent behavior, inbox folder). After that, you can attest hundreds of files without re-entering the same info.

arr init

PROMPT BEHAVIOR

Press Enter or type y to accept the default. Type n to skip optional fields. For yes/no questions, y = Yes and n = No.

Config locations:

# default (global)
~/.arr/config.json

# optional (per-project)
arr init --local   # writes ./.arr/config.json

See what ARR is using right now:

arr config

Attest One File

arr attest "/path/to/artwork.png"

Tip: drag-and-drop a file into the terminal to avoid quoting issues with spaces or parentheses.

OUTPUTS

PNG/JPEG files write new *.attested.png/*.attested.jpg copies. Other formats write a *.arr sidecar file next to the original.

Attest a Folder

Directories default to images only (safe, non-spammy). Add --all when you want sidecars for everything.

# PNG/JPEG only
arr attest "/path/to/folder" --recursive

# include everything (sidecars for non-images)
arr attest "/path/to/folder" --recursive --all

# custom extension filter
arr attest "/path/to/folder" --recursive --types png,jpg,jpeg

Drag & Drop Inbox (Hot Folder)

# Start watching the default inbox
arr watch

# Watch a custom folder and include everything
arr watch --in "/path/to/folder" --all

Drop files into the watched folder. ARR will attest them automatically using your saved defaults.

Verify or Extract

# Human-friendly
arr verify "/path/to/file.png"
arr extract "/path/to/file.png"

# Stable machine output
arr verify "/path/to/file.png" --json
arr extract "/path/to/file.png" --json

Troubleshooting

# Sanity check: should print version and exit
arr --version

COMMON ISSUES

zsh: “no matches found” means your path wasn’t quoted. Use quotes or drag-and-drop.

NEED A RESET?

Run arr init again to overwrite your saved config.

Prefer the markdown version? See docs/CLI-HOWTO.md.