CLI Usage

FileApex CLI Reference

Welcome to the command-line interface (CLI) reference for FileApex. The CLI allows you to interact with your local-first P2P cluster directly from your terminal, manage file transfers, monitor device states, and stream updates without opening the graphical app window.

Usage

fileapex [options] [arguments]

Available Commands

Help & Overview

• help, -h Display an overview of all available commands and options.

Interactive Dashboard

• dash, dashboard Launch an interactive Terminal User Interface (TUI) dashboard to monitor your cluster, manage peers, track streaming transfers, browse remote files, and control the transfer queue.

Device Management & Aliases

• devices Output a formatted table of authenticated paired devices, including generated slugs/aliases, online status, and battery percentage.
• alias [full_name] [short_slug] Map a user-defined short slug to a paired device for easier referencing in future commands.

Sending Files, Messages & Utilities

• send <file path> [alias] or send [alias] <file path> Send a file to a destination device. If you use bb for the alias, the file is sent to the Bulletin Board across all devices. Arguments can be passed in any order.
• send "message in quotes" [alias] or send [alias] "message in quotes" Send a text message to a destination device or broadcast it to the Bulletin Board (bb).
• send clip [alias] or send [alias] clip Send your current local clipboard content directly to the destination device.
• send beep [alias] or send [alias] beep Trigger an audible 'beep' on the destination device to help locate it.

Clipboard Operations

• clip [device/alias] Open an interactive prompt to send or retrieve clipboards with a target device.
• clip send [device/alias], clip push [device/alias] Send your current local clipboard content to the destination device.
• clip pull [device/alias], clip rec [device/alias], clip receive [device/alias], clip retrieve [device/alias] Retrieve remote clipboard content from a destination device (Note: if the target is an Android device, keep FileApex in the foreground).

Queue Management

• queue Output a formatted list of all pending transfers currently in the queue.
• queue remove <index> / queue rem <index> or queue remove <range> / queue rem <range> (e.g., 2-4) Remove a single transfer by its index or clear a range of items from the queue.