rightimaged

Command-line interface for the RightImaged DICOM imaging platform.

Install

brew install aluminumio/tap/rightimaged

Or download prebuilt binaries from Releases.

Usage

rightimaged <command> [options]

COMMANDS
  login        Authenticate via browser
  logout       Clear stored credentials
  whoami       Show current authenticated user
  sessions     List your DICOM scan sessions
  upload PATH  Upload a DICOM study (file, directory, or .iso)
  version      Print CLI version
  help         Show this help

FLAGS
  --json       JSON output
  -q, --quiet  Minimal output
  -y, --yes    Skip per-study upload prompt
  --limit N    Only upload first N slices per series (for testing)
  --api URL    Base URL override (also RIGHTIMAGED_API)

Authentication

rightimaged login opens your browser to authorize. The CLI polls until you approve, then stores the token at ~/.config/rightimaged/credentials.json (chmod 600).

rightimaged logout removes the stored credentials.

Environment

• RIGHTIMAGED_TOKEN — bearer token (skips credentials file, for headless/CI)
• RIGHTIMAGED_API — base URL override (default: https://app.rightimaged.com)

Examples

rightimaged login
rightimaged whoami
rightimaged sessions
rightimaged sessions --json | jq '.[] | select(.status == "ready")'

# Upload a directory of DICOM files
rightimaged upload ./study_dir/ --yes

# Upload a DICOM ISO (mounted automatically on macOS via hdiutil)
rightimaged upload ~/Downloads/disc.iso

# Quick smoke test: only the first 3 slices per series
rightimaged upload ./study_dir/ --yes --limit 3

Upload

rightimaged upload <path> accepts a single DICOM file, a directory tree, or a .iso (mounted automatically on macOS via hdiutil, and on Linux via mount -o loop). It walks the tree, parses metadata, groups files by study and series, then for each study:

1. Prompts you to confirm (skip with --yes).
2. Creates a scan session with study-level metadata.
3. Uploads each raw .dcm file using ActiveStorage direct uploads (POST /direct_upload, PUT to S3, then POST /attach).
4. Prints a summary.

The server handles conversion to display PNGs in a background job (coming soon).

Development

Requires Crystal >= 1.11.0.

make build      # dev build → bin/rightimaged
make release    # optimized build

Releases

Every merge to main triggers a release. Bump version: in shard.yml before merging, or CI will fail.

The repo secret REPO_DISPATCH_TOKEN must be set so the release workflow can notify aluminumio/homebrew-tap to update the Homebrew formula.

License

MIT