Command Reference

All commands require a valid session. Run pikpaktui (TUI) to log in first, or use login.

ls

List files and folders in your PikPak drive.

pikpaktui ls [options] [path]

Examples:

pikpaktui ls                               # list root (/)
pikpaktui ls "/My Pack"                   # list a folder
pikpaktui ls -l /Movies                   # long format
pikpaktui ls --sort=size -r /             # sort by size, largest first
pikpaktui ls -s created "/My Pack"        # sort by creation time
pikpaktui ls --tree /                     # full recursive tree
pikpaktui ls --tree --depth=2 "/My Pack"  # tree, max 2 levels
pikpaktui ls --tree -l /Movies            # tree with sizes and dates
pikpaktui ls /Movies --json               # JSON output
pikpaktui ls /Movies --json | jq '.[] | select(.size > 1073741824)'

mv

Move files or folders to a destination folder.

pikpaktui mv [options] <src> <dst>
pikpaktui mv [options] -t <dst> <src...>

Examples:

pikpaktui mv "/My Pack/file.txt" /Archive
pikpaktui mv -t /Archive /a.txt /b.txt /c.txt   # batch
pikpaktui mv -n "/My Pack/a.txt" /Archive        # dry run

cp

Copy files or folders to a destination folder.

pikpaktui cp [options] <src> <dst>
pikpaktui cp [options] -t <dst> <src...>

Examples:

pikpaktui cp "/My Pack/file.txt" /Backup
pikpaktui cp -t /Backup /a.txt /b.txt            # batch
pikpaktui cp -n -t /Backup /a.txt /b.txt         # dry run

rename

Rename a file or folder in place (stays in its current directory).

pikpaktui rename [options] <path> <new_name>

Examples:

pikpaktui rename "/My Pack/old.txt" new.txt
pikpaktui rename -n "/My Pack/old.txt" new.txt   # dry run

rm

Remove files or folders. By default, moves to trash (recoverable). Use -f for permanent deletion.

pikpaktui rm [options] <path...>

Examples:

pikpaktui rm "/My Pack/file.txt"             # move to trash
pikpaktui rm /a.txt /b.txt /c.txt            # batch trash
pikpaktui rm -r "/My Pack/folder"            # folder to trash
pikpaktui rm -rf "/My Pack/old-folder"       # permanent delete
pikpaktui rm -n "/My Pack/file.txt"          # dry run
pikpaktui rm -n -rf "/My Pack/folder"        # dry run permanent

mkdir

Create a new folder or a nested folder path.

pikpaktui mkdir [options] <parent_path> <folder_name>
pikpaktui mkdir [options] -p <full_path>

Examples:

pikpaktui mkdir "/My Pack" NewFolder          # create one folder
pikpaktui mkdir -p "/My Pack/a/b/c"           # create nested path
pikpaktui mkdir -n "/My Pack" NewFolder       # dry run
pikpaktui mkdir -n -p "/My Pack/a/b/c"        # dry run nested

info

Show detailed metadata for a file or folder, including media tracks for video files.

pikpaktui info [options] <path>

Examples:

pikpaktui info "/My Pack/video.mp4"
pikpaktui info "/My Pack/video.mp4" --json

link

Print the direct download URL for a file, optionally including video stream URLs.

pikpaktui link [options] <path>

Examples:

pikpaktui link "/My Pack/file.zip"
pikpaktui link "/My Pack/file.zip" --copy       # copy to clipboard
pikpaktui link "/My Pack/video.mp4" -m          # include stream URLs
pikpaktui link "/My Pack/file.zip" --json
pikpaktui link -mc "/My Pack/video.mp4"         # media + copy

cat

Print the text content of a file to stdout. Useful for previewing small text files or configs stored in PikPak.

pikpaktui cat <path>

Example:

pikpaktui cat "/My Pack/notes.txt"

play

Stream a video file using an external player. Lists available quality options if no quality is specified.

pikpaktui play <path> [quality]

Examples:

pikpaktui play "/My Pack/video.mp4"           # list available streams
pikpaktui play "/My Pack/video.mp4" 1080      # play 1080p
pikpaktui play "/My Pack/video.mp4" original  # play original file
pikpaktui play "/My Pack/video.mp4" 2         # play stream #2 by index

download

Download files or entire folders recursively to local storage.

pikpaktui download [options] <path>
pikpaktui download [options] -t <local_dir> <path...>

Examples:

pikpaktui download "/My Pack/file.txt"                  # to current dir
pikpaktui download "/My Pack/file.txt" /tmp/file.txt    # to specific path
pikpaktui download -o output.mp4 "/My Pack/video.mp4"   # custom name
pikpaktui download "/My Pack/folder"                    # recursive folder
pikpaktui download -j4 -t ./videos/ /a.mp4 /b.mp4      # 4 concurrent, batch
pikpaktui download -n "/My Pack/folder"                 # dry run

upload

Upload local files to PikPak. Supports deduplication (instant if file already exists server-side) and resumable uploads.

pikpaktui upload [options] <local_path> [remote_path]
pikpaktui upload [options] -t <remote_dir> <local...>

Examples:

pikpaktui upload ./file.txt                      # upload to root (/)
pikpaktui upload ./file.txt "/My Pack"           # upload to specific folder
pikpaktui upload -t "/My Pack" ./a.txt ./b.txt   # batch upload
pikpaktui upload -n ./file.txt "/My Pack"        # dry run

share

Create, list, save, and delete share links.

pikpaktui share [options] <path...>      # create
pikpaktui share -l                       # list your shares
pikpaktui share -S <url>                 # save a share to your drive
pikpaktui share -D <id...>               # delete share(s)

Create options:

Save options (with -S):

Examples:

pikpaktui share "/My Pack/file.txt"               # create plain share
pikpaktui share -p "/My Pack/file.txt"            # password-protected
pikpaktui share -d 7 "/My Pack/file.txt"          # expires in 7 days
pikpaktui share -p -d 7 /a.txt /b.txt             # multiple files, password, 7 days
pikpaktui share -J "/My Pack/file.txt"            # JSON output

pikpaktui share -l                                # list all your shares
pikpaktui share -l -J                             # JSON list

pikpaktui share -D abc123                         # delete one share
pikpaktui share -D abc123 def456                  # delete multiple

pikpaktui share -S "https://mypikpak.com/s/XXXX"              # save to /
pikpaktui share -S -p PO -t "/My Pack" "https://..."          # with password + destination
pikpaktui share -S -n "https://mypikpak.com/s/XXXX"           # dry run

offline

Submit a URL or magnet link for server-side (cloud) downloading. The download runs on PikPak's servers.

pikpaktui offline [options] <url>

Examples:

pikpaktui offline "magnet:?xt=urn:btih:abc123..."
pikpaktui offline --to "/Downloads" "https://example.com/file.zip"
pikpaktui offline --to "/Downloads" --name "myvideo.mp4" "https://..."
pikpaktui offline --dry-run "magnet:?xt=..."

tasks

Manage offline download tasks.

pikpaktui tasks [subcommand] [options] [limit]

Subcommands:

Options:

Examples:

pikpaktui tasks                             # list up to 50 tasks
pikpaktui tasks list 10                    # list 10 tasks
pikpaktui tasks list --json                # JSON output
pikpaktui tasks retry abc12345             # retry a failed task
pikpaktui tasks delete abc12345            # delete a task
pikpaktui tasks rm abc12345 def67890       # delete multiple tasks

trash

List files currently in the trash.

pikpaktui trash [options] [limit]

Examples:

pikpaktui trash                  # list up to 100 trashed files
pikpaktui trash 50               # limit to 50
pikpaktui trash -l               # long format
pikpaktui trash --json           # JSON output

untrash

Restore one or more files from trash by exact filename.

pikpaktui untrash [options] <name...>

Examples:

pikpaktui untrash "file.txt"
pikpaktui untrash "a.txt" "b.mp4"       # restore multiple
pikpaktui untrash -n "file.txt"         # dry run

star

Star (bookmark) one or more files.

pikpaktui star <path...>

Examples:

pikpaktui star "/My Pack/video.mp4"
pikpaktui star "/My Pack/a.txt" "/My Pack/b.txt"

unstar

Remove the star from one or more files.

pikpaktui unstar <path...>

Example:

pikpaktui unstar "/My Pack/video.mp4"

starred

List all starred files.

pikpaktui starred [options] [limit]

Examples:

pikpaktui starred
pikpaktui starred 50
pikpaktui starred -l
pikpaktui starred --json

events

List recent file activity (uploads, downloads, deletions, etc.).

pikpaktui events [options] [limit]

Examples:

pikpaktui events
pikpaktui events 50
pikpaktui events --json

login

Log in to PikPak and save credentials to ~/.config/pikpaktui/login.yaml.

pikpaktui login [options]

Environment variable fallbacks (lower priority than flags):

Examples:

pikpaktui login                                         # interactive prompt
pikpaktui login -u user@example.com -p mypassword
PIKPAK_USER=user@example.com PIKPAK_PASS=pass pikpaktui login

quota

Show your storage quota and bandwidth usage.

pikpaktui quota [options]

Examples:

pikpaktui quota
pikpaktui quota --json

vip

Show VIP membership status, invite code, and transfer quota.

pikpaktui vip

update

Check for updates and self-update the binary from GitHub releases.

pikpaktui update

Downloads the latest release for your platform and replaces the current binary in-place.

completions

Generate shell completion scripts. Currently only Zsh is supported.

pikpaktui completions <shell>

Examples:

pikpaktui completions zsh                            # print to stdout
pikpaktui completions zsh > ~/.zfunc/_pikpaktui      # save to file
eval "$(pikpaktui completions zsh)"                  # load in current shell

See Shell Completions for full setup instructions.