PikPak is a private cloud drive.
Paths are specified as remote:path
, and may be as deep as required, e.g. remote:directory/subdirectory
.
Here is an example of making a remote for PikPak.
First run:
rclone config
This will guide you through an interactive setup process:
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
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.
Here are the Standard options specific to pikpak (PikPak).
Pikpak username.
Properties:
Pikpak password.
NB Input to this must be obscured - see rclone obscure.
Properties:
Here are the Advanced options specific to pikpak (PikPak).
OAuth Client Id.
Leave blank normally.
Properties:
OAuth Client Secret.
Leave blank normally.
Properties:
OAuth Access Token as a JSON blob.
Properties:
Auth server URL.
Leave blank to use the provider defaults.
Properties:
Token server url.
Leave blank to use the provider defaults.
Properties:
ID of the root folder. Leave blank normally.
Fill in for rclone to use a non root folder as its starting point.
Properties:
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:
Only show files that are in the trash.
This will show trashed files in their original directory structure.
Properties:
Files bigger than this will be cached on disk to calculate hash if required.
Properties:
The encoding for the backend.
See the encoding section in the overview for more info.
Properties:
Here are the commands specific to the pikpak backend.
Run them with
rclone backend COMMAND remote:
The help below will explain what arguments each command takes.
See the 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.
Add offline download task for url
rclone backend addurl remote: [options] [<arguments>+]
This command adds offline download task for url.
Usage:
rclone backend addurl pikpak:dirpath url
Downloads will be stored in 'dirpath'. If 'dirpath' is invalid, download will fallback to default 'My Pack' folder.
Request decompress of a file/files in a folder
rclone backend decompress remote: [options] [<arguments>+]
This command requests decompress of file/files in a folder.
Usage:
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:
{
"Decompressed": 17,
"SourceDeleted": 0,
"Errors": 0
}
PikPak supports MD5 hash, but sometimes given empty especially for user-uploaded files.
Deleted files will still be visible with --pikpak-trashed-only
even after the
trash emptied. This goes away after few days.