keibidrop-cli Command Reference

The interactive terminal client. You type commands at a prompt.

Model

keibidrop-cli is a REPL. Start it with no arguments. There are no command-line flags.

The prompt is keibidrop> . Tab completion suggests commands. Type help for the built-in list, exit to quit.

On start, the client does this, in order:

Loads the config file. On the first run, it writes a commented default file. See the configuration reference.
Creates the save, log, and mount directories if they are missing.
Connects to the relay.
If passphrase_protect is on, asks for your passphrase. This is the only interactive prompt at startup.
Prints the banner, the version, the config, log, save, and mount paths, and your fingerprint.
Shows the keibidrop> prompt.

There is no setup wizard. Your identity is created silently on the first run and reused after that.

Command	Description
`help`	Show the command list.
`version`	Show the banner and version.
`status`	Full connection and session status.
`show <what>`	Show one value. See show arguments.
`exit`	Disconnect, unmount, and quit. `quit` is an alias.

Command	Description
`register <fingerprint>`	Register the peer's fingerprint. On a LAN, an `ip:port` address from `discover` is also accepted.
`discover`	Scan the local network for about 10 seconds. Lists nearby peers with their addresses.
`connect`	Connect to the registered peer. The role is chosen automatically by fingerprint.
`create`	Create a room and wait for the peer.
`join`	Join a room the peer created first.
`disconnect`	Disconnect and reset the session. Prints your new fingerprint.
`peer-info`	Peer details and connection mode.

Command	Description
`add <filepath>`	Share a file or directory.
`add-as <path> <remote-name>`	Share with a custom remote name.
`unshare <filename>`	Stop sharing a file. The file stays on disk. `delete` does the same.
`list`	List shared files and their locations.
`pull <remote> <local>`	Copy a file or folder from the peer. Both arguments are required.
`cancel-download <name>`	Pause an active download. Partial data is kept.
`progress <name>`	Download progress, 0-100%.

Command	Description
`contacts`	List saved contacts.
`add-contact <name> <fingerprint>`	Save a contact.
`remove-contact <fingerprint>`	Remove a saved contact.
`quick-connect <fingerprint>`	Connect to a saved contact.
`save-contact <name>`	Save the currently connected peer as a contact.

Command	Description
`incognito [on\|off]`	Query or toggle incognito mode.
`poll-event`	Pop the next event from the event queue.
`export-logs [dest]`	Export a sanitized copy of the log. `sanitize-logs` is an alias.

Command	Shows
`show fingerprint`	Your fingerprint.
`show ip`	Your IP.
`show peer fingerprint`	The peer's fingerprint.
`show peer ip`	The peer's IP.
`show relay`	The connected relay URL.
`show config`	The full configuration in effect: paths, ports, bridge, modes, identity, and contact count.

pull requires both arguments here. In kd, the local path is optional.
An unknown command prints Unknown command: <name>. A wrong argument count prints a Usage: line.
The free public relay allows about 3 connection attempts per 5 minutes. If you hit the limit, wait 5 minutes.
For scripts, use kd instead. Its output is JSON.