pikpaktui

A TUI and CLI client for PikPak cloud storage, written in pure Rust with no external runtime dependencies.

Features

• TUI file browser - Navigate folders, breadcrumb path display, Nerd Font icons
• CLI subcommands - ls / mv / cp / rename / rm / mkdir / download / upload / share / quota
• File operations - Move, copy, rename, delete (trash), create folder
• Folder picker - Visual two-pane picker for move/copy destinations, with tab-completion text input as alternative
• File download - Download files with resume support
• Quota query - Check storage usage
• Login - TUI login form with auto-saved credentials and persistent sessions
• Pure Rust - Built with ratatui + crossterm + reqwest (rustls), no OpenSSL or C dependencies

Install

Homebrew (macOS / Linux)

brew install Bengerthelorf/tap/pikpaktui

Cargo

cargo install pikpaktui

From source

git clone https://github.com/Bengerthelorf/pikpaktui.git
cd pikpaktui
cargo build --release
./target/release/pikpaktui

GitHub Releases

Pre-built binaries for Linux (x86_64, static musl), macOS Intel, and macOS Apple Silicon are available on the Releases page.

Usage

TUI mode

Run without arguments to launch the interactive file browser:

pikpaktui

If no valid session exists, a login form will appear. After login, credentials are saved to config.yaml and the session is persisted to session.json.

CLI mode

pikpaktui ls /                                        # List files in colored multi-column grid
pikpaktui ls -l "/My Pack"                            # Long format (id + size + date + name)
pikpaktui mv "/My Pack/file.txt" /Archive             # Move file
pikpaktui cp "/My Pack/file.txt" /Backup              # Copy file
pikpaktui rename "/My Pack/old.txt" new.txt           # Rename
pikpaktui rm "/My Pack/file.txt"                      # Delete (to trash)
pikpaktui mkdir "/My Pack" newfolder                  # Create folder
pikpaktui download "/My Pack/file.txt"                # Download to current dir
pikpaktui download "/My Pack/file.txt" /tmp/file.txt  # Download to path
pikpaktui upload ./local-file.txt "/My Pack"          # Upload a file
pikpaktui share "/My Pack/file.txt"                   # Print PikPak share links
pikpaktui share "/My Pack" -o links.txt               # Save share links to file
pikpaktui quota                                       # Show storage quota

CLI mode requires login: it checks for a valid session first, then falls back to config.yaml credentials. If neither exists, run pikpaktui (TUI) to login.

TUI Keybindings

Folder Picker (Move/Copy)

Text Input (Move/Copy)

Configuration

Credentials (config.yaml)

~/.config/pikpaktui/config.yaml

username: "you@example.com"
password: "your-password"

TUI settings (config.toml)

~/.config/pikpaktui/config.toml

nerd_font = false       # Enable Nerd Font icons (TUI)
cli_nerd_font = false   # Enable Nerd Font icons (CLI)
move_mode = "picker"    # "picker" (two-pane) or "input" (text input)
show_help_bar = true    # Show help bar at the bottom

Project Structure

src/
  main.rs           Entry point, TUI launcher
  config.rs         config.yaml / config.toml loading
  pikpak.rs         PikPak API client (auth, file ops, download, upload)
  theme.rs          File icons and colors
  cmd/
    mod.rs          Shared CLI helpers (client init, path utils)
    ls.rs           ls command
    mv.rs           mv command
    cp.rs           cp command
    rename.rs       rename command
    rm.rs           rm command
    mkdir.rs        mkdir command
    download.rs     download command
    upload.rs       upload command
    share.rs        share command
    quota.rs        quota command
    help.rs         help command
  tui/
    mod.rs          App state and event loop
    draw.rs         UI rendering (file list, picker, help sheet)
    handler.rs      Keyboard input handling
    completion.rs   Path tab-completion

License

Apache-2.0