SWAMPy

✎ CARVE FLESH

EDITING: pikpak.md

---
title: "PikPak"
description: "Rclone docs for PikPak"
versionIntroduced: "v1.62"
---

# PikPak

PikPak is [a private cloud drive](https://mypikpak.com/).

Paths are specified as `remote:path`, and may be as deep as required, e.g. `remote:directory/subdirectory`.

## Configuration

Here is an example of making a remote for PikPak.

First run:

```console
rclone config
```

This will guide you through an interactive setup process:

```text
No remotes found, make a new one?
n) New remote
s) Set configuration password
q) Quit config
n/s/q> n

Enter name for new remote.
name> remote

Option Storage.
Type of storage to configure.
Choose a number from below, or type in your own value.
XX / PikPak
   \ (pikpak)
Storage> XX

Option user.
Pikpak username.
Enter a value.
user> USERNAME

Option pass.
Pikpak password.
Choose an alternative below.
y) Yes, type in my own password
g) Generate random password
y/g> y
Enter the password:
password:
Confirm the password:
password:

Edit advanced config?
y) Yes
n) No (default)
y/n>

Configuration complete.
Options:
- type: pikpak
- user: USERNAME
- pass: *** ENCRYPTED ***
- token: {"access_token":"eyJ...","token_type":"Bearer","refresh_token":"os...","expiry":"2023-01-26T18:54:32.170582647+09:00"}
Keep this "remote" remote?
y) Yes this is OK (default)
e) Edit this remote
d) Delete this remote
y/e/d> y
```

### Modification times and hashes

PikPak keeps modification times on objects, and updates them when uploading objects,
but it does not support changing only the modification time

The MD5 hash algorithm is supported.

### Standard options

Here are the Standard options specific to pikpak (PikPak).

#### --pikpak-user

Pikpak username.

Properties:

- Config:      user
- Env Var:     RCLONE_PIKPAK_USER
- Type:        string
- Required:    true

#### --pikpak-pass

Pikpak password.

**NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).

Properties:

- Config:      pass
- Env Var:     RCLONE_PIKPAK_PASS
- Type:        string
- Required:    true

### Advanced options

Here are the Advanced options specific to pikpak (PikPak).

#### --pikpak-device-id

Device ID used for authorization.

Properties:

- Config:      device_id
- Env Var:     RCLONE_PIKPAK_DEVICE_ID
- Type:        string
- Required:    false

#### --pikpak-user-agent

HTTP user agent for pikpak.

Defaults to "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0" or "--pikpak-user-agent" provided on command line.

Properties:

- Config:      user_agent
- Env Var:     RCLONE_PIKPAK_USER_AGENT
- Type:        string
- Default:     "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0"

#### --pikpak-root-folder-id

ID of the root folder.
Leave blank normally.

Fill in for rclone to use a non root folder as its starting point.

Properties:

- Config:      root_folder_id
- Env Var:     RCLONE_PIKPAK_ROOT_FOLDER_ID
- Type:        string
- Required:    false

#### --pikpak-use-trash

Send files to the trash instead of deleting permanently.

Defaults to true, namely sending files to the trash.
Use `--pikpak-use-trash=false` to delete files permanently instead.

Properties:

- Config:      use_trash
- Env Var:     RCLONE_PIKPAK_USE_TRASH
- Type:        bool
- Default:     true

#### --pikpak-trashed-only

Only show files that are in the trash.

This will show trashed files in their original directory structure.

Properties:

- Config:      trashed_only
- Env Var:     RCLONE_PIKPAK_TRASHED_ONLY
- Type:        bool
- Default:     false

#### --pikpak-no-media-link

Use original file links instead of media links.

This avoids issues caused by invalid media links, but may reduce download speeds.

Properties:

- Config:      no_media_link
- Env Var:     RCLONE_PIKPAK_NO_MEDIA_LINK
- Type:        bool
- Default:     false

#### --pikpak-hash-memory-limit

Files bigger than this will be cached on disk to calculate hash if required.

Properties:

- Config:      hash_memory_limit
- Env Var:     RCLONE_PIKPAK_HASH_MEMORY_LIMIT
- Type:        SizeSuffix
- Default:     10Mi

#### --pikpak-upload-cutoff

Cutoff for switching to chunked upload.

Any files larger than this will be uploaded in chunks of chunk_size.
The minimum is 0 and the maximum is 5 GiB.

Properties:

- Config:      upload_cutoff
- Env Var:     RCLONE_PIKPAK_UPLOAD_CUTOFF
- Type:        SizeSuffix
- Default:     200Mi

#### --pikpak-chunk-size

Chunk size for multipart uploads.
	
Large files will be uploaded in chunks of this size.

Note that this is stored in memory and there may be up to
"--transfers" * "--pikpak-upload-concurrency" chunks stored at once
in memory.

If you are transferring large files over high-speed links and you have
enough memory, then increasing this will speed up the transfers.

Rclone will automatically increase the chunk size when uploading a
large file of known size to stay below the 10,000 chunks limit.

Increasing the chunk size decreases the accuracy of the progress
statistics displayed with "-P" flag.

Properties:

- Config:      chunk_size
- Env Var:     RCLONE_PIKPAK_CHUNK_SIZE
- Type:        SizeSuffix
- Default:     5Mi

#### --pikpak-upload-concurrency

Concurrency for multipart uploads.

This is the number of chunks of the same file that are uploaded
concurrently for multipart uploads.

Note that chunks are stored in memory and there may be up to
"--transfers" * "--pikpak-upload-concurrency" chunks stored at once
in memory.

If you are uploading small numbers of large files over high-speed links
and these uploads do not fully utilize your bandwidth, then increasing
this may help to speed up the transfers.

Properties:

- Config:      upload_concurrency
- Env Var:     RCLONE_PIKPAK_UPLOAD_CONCURRENCY
- Type:        int
- Default:     4

#### --pikpak-encoding

The encoding for the backend.

See the [encoding section in the overview](/overview/#encoding) for more info.

Properties:

- Config:      encoding
- Env Var:     RCLONE_PIKPAK_ENCODING
- Type:        Encoding
- Default:     Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot

#### --pikpak-description

Description of the remote.

Properties:

- Config:      description
- Env Var:     RCLONE_PIKPAK_DESCRIPTION
- Type:        string
- Required:    false

## Backend commands

Here are the commands specific to the pikpak backend.

Run them with:

```console
rclone backend COMMAND remote:
```

The help below will explain what arguments each command takes.

See the [backend](/commands/rclone_backend/) command for more
info on how to pass options and arguments.

These can be run on a running backend using the rc command
[backend/command](/rc/#backend-command).

### addurl

Add offline download task for url.

```console
rclone backend addurl remote: [options] [<arguments>+]
```

This command adds offline download task for url.

Usage examples:

```console
rclone backend addurl pikpak:dirpath url
rclone backend addurl pikpak:dirpath url -o name=custom_filename.zip
```

Downloads will be stored in 'dirpath'. If 'dirpath' is invalid,
download will fallback to default 'My Pack' folder.

Options:

- "name": Custom filename for the downloaded file.

### decompress

Request decompress of a file/files in a folder.

```console
rclone backend decompress remote: [options] [<arguments>+]
```

This command requests decompress of file/files in a folder.

Usage examples:

```console
rclone backend decompress pikpak:dirpath {filename} -o password=password
rclone backend decompress pikpak:dirpath {filename} -o delete-src-file
```

An optional argument 'filename' can be specified for a file located in
'pikpak:dirpath'. You may want to pass '-o password=password' for a
password-protected files. Also, pass '-o delete-src-file' to delete
source files after decompression finished.

Result:

```json
{
    "Decompressed": 17,
    "SourceDeleted": 0,
    "Errors": 0
}
```

## Limitations

### Hashes may be empty

PikPak supports MD5 hash, but sometimes given empty especially for user-uploaded files.

### Deleted files still visible with trashed-only

Deleted files will still be visible with `--pikpak-trashed-only` even after the
trash emptied. This goes away after few days.

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 commands/	DIR	—	2026-10-22 22:33
📁 oracleobjectstorage/	DIR	—	2026-10-22 22:33
📄 _index.md	MD	17.8 KB	2026-10-09 09:34	EDIT
📄 alias.md	MD	3.4 KB	2026-10-09 09:34	EDIT
📄 amazonclouddrive.md	MD	472 B	2026-10-09 09:34	EDIT
📄 archive.md	MD	9.9 KB	2026-10-09 09:34	EDIT
📄 authors.md	MD	49.6 KB	2026-10-09 09:34	EDIT
📄 azureblob.md	MD	34.9 KB	2026-10-09 09:34	EDIT
📄 azurefiles.md	MD	23.1 KB	2026-10-09 09:34	EDIT
📄 b2.md	MD	23.3 KB	2026-10-09 09:34	EDIT
📄 backends.md	MD	61 B	2026-10-09 09:34	EDIT
📄 bisync.md	MD	105.5 KB	2026-10-11 09:54	EDIT
📄 box.md	MD	14.2 KB	2026-10-09 09:34	EDIT
📄 bugs.md	MD	1.6 KB	2026-10-09 09:34	EDIT
📄 cache.md	MD	21 KB	2026-10-09 09:34	EDIT
📄 changelog.md	MD	369.6 KB	2026-10-09 09:34	EDIT
📄 chunker.md	MD	18.4 KB	2026-10-09 09:34	EDIT
📄 cloudinary.md	MD	6.3 KB	2026-10-09 09:34	EDIT
📄 combine.md	MD	4.2 KB	2026-10-09 09:34	EDIT
📄 compress.md	MD	6.3 KB	2026-10-09 09:34	EDIT
📄 contact.md	MD	845 B	2026-10-09 09:34	EDIT
📄 crypt.md	MD	27.7 KB	2026-10-09 09:34	EDIT
📄 docker.md	MD	23.7 KB	2026-10-09 09:34	EDIT
📄 docs.md	MD	134.2 KB	2026-10-09 09:34	EDIT
📄 doi.md	MD	4.3 KB	2026-10-09 09:34	EDIT
📄 downloads.md	MD	7.6 KB	2026-10-09 09:34	EDIT
📄 drime.md	MD	7.6 KB	2026-10-09 09:34	EDIT
📄 drive.md	MD	64.7 KB	2026-10-09 09:34	EDIT
📄 dropbox.md	MD	21.2 KB	2026-10-09 09:34	EDIT
📄 faq.md	MD	13.3 KB	2026-10-09 09:34	EDIT
📄 fichier.md	MD	5.5 KB	2026-10-09 09:34	EDIT
📄 filefabric.md	MD	7.4 KB	2026-10-09 09:34	EDIT
📄 filelu.md	MD	6.6 KB	2026-10-09 09:34	EDIT
📄 filen.md	MD	5.3 KB	2026-10-09 09:34	EDIT
📄 filescom.md	MD	5.7 KB	2026-10-09 09:34	EDIT
📄 filtering.md	MD	32 KB	2026-10-09 09:34	EDIT
📄 flags.md	MD	121.9 KB	2026-10-09 09:34	EDIT
📄 ftp.md	MD	15.8 KB	2026-10-09 09:34	EDIT
📄 gofile.md	MD	6.8 KB	2026-10-09 09:34	EDIT
📄 googlecloudstorage.md	MD	22.6 KB	2026-10-09 09:34	EDIT
📄 googlephotos.md	MD	19.5 KB	2026-10-09 09:34	EDIT
📄 gui.md	MD	4 KB	2026-10-09 09:34	EDIT
📄 hasher.md	MD	10.5 KB	2026-10-09 09:34	EDIT
📄 hdfs.md	MD	6.2 KB	2026-10-09 09:34	EDIT
📄 hidrive.md	MD	13.7 KB	2026-10-09 09:34	EDIT
📄 http.md	MD	10 KB	2026-10-09 09:34	EDIT
📄 huaweidrive.md	MD	16.1 KB	2026-10-09 09:34	EDIT
📄 iclouddrive.md	MD	9 KB	2026-10-09 09:34	EDIT
📄 imagekit.md	MD	6.4 KB	2026-10-09 09:34	EDIT
📄 install.md	MD	25.9 KB	2026-10-09 09:34	EDIT
📄 install.sh	SH	4.6 KB	2026-10-09 09:34	EDIT
📄 internetarchive.md	MD	11.2 KB	2026-10-09 09:34	EDIT
📄 internxt.md	MD	5.1 KB	2026-10-09 09:34	EDIT
📄 jottacloud.md	MD	21.6 KB	2026-10-09 09:34	EDIT
📄 KEYS	?	7.8 KB	2026-10-09 09:34	EDIT
📄 koofr.md	MD	8.7 KB	2026-10-09 09:34	EDIT
📄 licence.md	MD	1.3 KB	2026-10-09 09:34	EDIT
📄 linkbox.md	MD	2.8 KB	2026-10-09 09:34	EDIT
📄 local.md	MD	24.2 KB	2026-10-09 09:34	EDIT
📄 mailru.md	MD	11.6 KB	2026-10-09 09:34	EDIT
📄 mega.md	MD	9.4 KB	2026-10-09 09:34	EDIT
📄 memory.md	MD	2.6 KB	2026-10-09 09:34	EDIT
📄 netstorage.md	MD	11 KB	2026-10-09 09:34	EDIT
📄 onedrive.md	MD	49.3 KB	2026-10-09 09:34	EDIT
📄 opendrive.md	MD	5.5 KB	2026-10-09 09:34	EDIT
📄 overview.md	MD	20 KB	2026-10-09 09:34	EDIT
📄 pcloud.md	MD	9.3 KB	2026-10-09 09:34	EDIT
📄 pikpak.md	MD	8.3 KB	2026-10-09 09:34	EDIT
📄 pixeldrain.md	MD	4.9 KB	2026-10-09 09:34	EDIT
📄 premiumizeme.md	MD	5.8 KB	2026-10-09 09:34	EDIT
📄 privacy.md	MD	11.6 KB	2026-10-09 09:34	EDIT
📄 protondrive.md	MD	10.8 KB	2026-10-09 09:34	EDIT
📄 putio.md	MD	5.4 KB	2026-10-09 09:34	EDIT
📄 qingstor.md	MD	8.7 KB	2026-10-09 09:34	EDIT
📄 quatrix.md	MD	7.7 KB	2026-10-09 09:34	EDIT
📄 rc.md	MD	91.3 KB	2026-10-09 09:34	EDIT
📄 release_signing.md	MD	5.5 KB	2026-10-09 09:34	EDIT
📄 remote_setup.md	MD	4.1 KB	2026-10-09 09:34	EDIT
📄 s3.md	MD	302.6 KB	2026-10-09 09:34	EDIT
📄 seafile.md	MD	10.5 KB	2026-10-09 09:34	EDIT
📄 sftp.md	MD	43 KB	2026-10-09 09:34	EDIT
📄 shade.md	MD	6.3 KB	2026-10-09 09:34	EDIT
📄 sharefile.md	MD	9 KB	2026-10-09 09:34	EDIT
📄 sia.md	MD	6.8 KB	2026-10-09 09:34	EDIT
📄 smb.md	MD	6.9 KB	2026-10-09 09:34	EDIT
📄 sponsor.md	MD	4.5 KB	2026-10-09 09:34	EDIT
📄 storj.md	MD	14.9 KB	2026-10-09 09:34	EDIT
📄 sugarsync.md	MD	7 KB	2026-10-09 09:34	EDIT
📄 swift.md	MD	20.3 KB	2026-10-09 09:34	EDIT
📄 tiers.md	MD	2.1 KB	2026-10-09 09:34	EDIT
📄 ulozto.md	MD	7.6 KB	2026-10-09 09:34	EDIT
📄 union.md	MD	11.9 KB	2026-10-09 09:34	EDIT
📄 webdav.md	MD	16.1 KB	2026-10-09 09:34	EDIT
📄 yandex.md	MD	7.8 KB	2026-10-09 09:34	EDIT
📄 zoho.md	MD	11.3 KB	2026-10-09 09:34	EDIT