Skip to main content

Command Line Tool

Install the ferry command, its commands and flags, and its exit codes.

On this page

The ferry command is embedded in the app. Install it from Settings → Automation → Install “ferry” Command….

Commands

usage: ferry <command> [options]

History
  list                 * the most recent clips (--board, --since to narrow)
  search <query>       * search history (same query language as the panel)
  get <clip>           * print a clip's content
  boards               * list pinboards
  copy [clip]            put standard input, or a clip, on the clipboard
  paste <clip>         * paste a clip into the frontmost app
  push [text]          * add text (or standard input) to history as a new clip
  pop                  * print the newest clip and remove it from history
  delete <clip>...     * delete clips now
  clear --yes          * erase history, keeping pinned, named, pinboard and locked clips

Text
  transform <id>...      apply transforms to standard input, write standard output
  transforms             list transform ids

App
  queue add|next|clear * manage the paste queue
  pause [minutes]      * pause capture (until resumed, or for some minutes)
  resume               * resume capture

  help [command]         show help for a command
  --version              print the version

<clip> is a position from 'ferry list' (1 is the most recent) or a clip UUID.
(* = talks to the running app; App Lock applies)

Flags

FlagWorks withWhat it does
--jsonlist, search, get, boards, transformsPrint JSON
--since 2hlist, searchOnly clips since a time (2h, 3d or an ISO date)
--board NAMElist, searchOnly clips on a pinboard
-n 20list, searchNumber of results (10 for list, 20 for search by default)
--shape, -spastePaste in a shape: original, plainText, markdown, html, codeBlock, quote, titledLink or file
--transform, -tpasteApply a transform before pasting; repeat for a chain
--linesqueue addQueue each non-empty line of standard input
--yesclearConfirm erasing history

Exit codes

CodeMeaning
0Success
1Wrong usage or bad input
2Ferry isn't running
3Not found
4Not allowed: a sensitive clip, Ferry is locked, or a macOS permission Ferry lacks
5The command failed

Sensitive clips are never printed. ferry transform works even when Ferry isn't running.

Examples

pbpaste | ferry transform case.upper text.trim
ferry search "type:link from:github.com" --json
ferry list --since 2h
echo "deploy notes" | ferry push
ferry paste 3 --shape markdown

Still need help? Email support@ferry.app.