Skip to content

CLI Guide

Welcome to the Dorsal CLI Guide!

Get to know the Dorsal Command Line Interface (CLI).

If you'd rather get started with the Python API, check out the Python Guide

Command Reference

Command Group Sub-commands Description
dorsal auth login, whoami, logout, gitignore Manage authentication with your DorsalHub account.
dorsal file scan, hash, report, identify, push Analyze, hash, and push local files one at a time.
dorsal dir info, scan, duplicates, push Scan, find duplicates, and push entire directories in bulk.
dorsal record get, tag add, tag rm, search, delete Manage remote metadata records that are on DorsalHub.
dorsal collection list, show, add-files, update, make-public... Group and organize your remote records into collections.
dorsal cache show, path, build, prune, optimize, clear Manage the local metadata cache to improve performance.
dorsal config show, theme list, theme set View your local configuration and customize the CLI.

What We'll Cover

  • Connect to DorsalHub: Use dorsal auth to securely log in and check your connection status.
  • Analyze Local Files: Use dorsal file to scan, hash, and push metadata for individual files to DorsalHub.
  • Work with Directories: Use dorsal dir to scan, hash, deduplicate and push metadata for entire directories of files to DorsalHub.
  • Search and Manage Records: Use dorsal record to find, tag, and manage your metadata once it's on DorsalHub.
  • Build Datasets: Use dorsal collection to group your remote records into logical, shareable "collections."
  • Tune Your CLI: Use dorsal config to change themes and dorsal cache to manage the local metadata cache.

Prerequisites

  1. Dorsal is installed: You have a terminal open with Dorsal already installed.
  2. You have some files: Any kind of files (PDFs, images, etc.) on your computer that you can point the commands at.

Let's Begin!

  • 🔑 Get Authenticated

    If want to learn more about linking your Dorsal installation with your DorsalHub account:

    Authentication

  • 🖥️ Working with Files

    If you are already authenticated, or just want to get to know the offline commands, start with dorsal file:

    Local Files