Skip to content

CLI Overview

pikpaktui provides 27 CLI subcommands for scripting, automation, and power-user workflows. All commands require a valid session — run pikpaktui (TUI) first to log in, or use pikpaktui login.

Command Groups

File Management

CommandDescription
lsList files and folders
mvMove files or folders
cpCopy files or folders
renameRename a file or folder
rmRemove to trash (or permanently with -f)
mkdirCreate folders
infoDetailed file/folder metadata
linkGet direct download URL
catPreview text file contents

Playback

CommandDescription
playStream video with external player

Transfer

CommandDescription
downloadDownload files or folders
uploadUpload files to PikPak
shareCreate, list, save, or delete share links

Cloud Download

CommandDescription
offlineSubmit URL or magnet for server-side download
tasksManage offline download tasks

Trash

CommandDescription
trashList trashed files
untrashRestore files from trash by name

Starred & Activity

CommandDescription
starStar files
unstarUnstar files
starredList starred files
eventsRecent file activity

Auth

CommandDescription
loginLog in and save credentials

Account

CommandDescription
quotaStorage and bandwidth quota
vipVIP status and account info

Utility

CommandDescription
updateCheck for updates and self-update
completionsGenerate shell completions

Common Flags

JSON output

Most commands that list data support -J / --json for machine-readable output — pipe to jq for filtering:

bash
pikpaktui ls /Movies --json | jq '.[] | select(.size > 1073741824)'
pikpaktui info "/My Pack/video.mp4" --json
pikpaktui quota --json

Dry run

All commands that modify data accept -n / --dry-run. This resolves paths and prints a detailed plan without making any changes:

bash
pikpaktui rm -n "/My Pack/file.txt"
pikpaktui mv -n "/My Pack/a.txt" /Archive
pikpaktui download -n "/My Pack/folder"
pikpaktui upload -n ./file.txt "/My Pack"

Batch mode (-t)

mv, cp, download, and upload support -t <destination> for operating on multiple items at once:

bash
pikpaktui mv -t /Archive /a.txt /b.txt /c.txt
pikpaktui download -t ./local/ /a.mp4 /b.mp4
pikpaktui upload -t "/My Pack" ./a.txt ./b.txt

Released under the Apache-2.0 License.