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
| Command | Description |
|---|---|
ls | List files and folders |
mv | Move files or folders |
cp | Copy files or folders |
rename | Rename a file or folder |
rm | Remove to trash (or permanently with -f) |
mkdir | Create folders |
info | Detailed file/folder metadata |
link | Get direct download URL |
cat | Preview text file contents |
Playback
| Command | Description |
|---|---|
play | Stream video with external player |
Transfer
| Command | Description |
|---|---|
download | Download files or folders |
upload | Upload files to PikPak |
share | Create, list, save, or delete share links |
Cloud Download
| Command | Description |
|---|---|
offline | Submit URL or magnet for server-side download |
tasks | Manage offline download tasks |
Trash
| Command | Description |
|---|---|
trash | List trashed files |
untrash | Restore files from trash by name |
Starred & Activity
| Command | Description |
|---|---|
star | Star files |
unstar | Unstar files |
starred | List starred files |
events | Recent file activity |
Auth
| Command | Description |
|---|---|
login | Log in and save credentials |
Account
| Command | Description |
|---|---|
quota | Storage and bandwidth quota |
vip | VIP status and account info |
Utility
| Command | Description |
|---|---|
update | Check for updates and self-update |
completions | Generate 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 --jsonDry 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