github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/docs/content/pikpak.md (about) 1 --- 2 title: "PikPak" 3 description: "Rclone docs for PikPak" 4 versionIntroduced: "v1.62" 5 --- 6 7 # {{< icon "fa fa-cloud" >}} PikPak 8 9 PikPak is [a private cloud drive](https://mypikpak.com/). 10 11 Paths are specified as `remote:path`, and may be as deep as required, e.g. `remote:directory/subdirectory`. 12 13 ## Configuration 14 15 Here is an example of making a remote for PikPak. 16 17 First run: 18 19 rclone config 20 21 This will guide you through an interactive setup process: 22 23 ``` 24 No remotes found, make a new one? 25 n) New remote 26 s) Set configuration password 27 q) Quit config 28 n/s/q> n 29 30 Enter name for new remote. 31 name> remote 32 33 Option Storage. 34 Type of storage to configure. 35 Choose a number from below, or type in your own value. 36 XX / PikPak 37 \ (pikpak) 38 Storage> XX 39 40 Option user. 41 Pikpak username. 42 Enter a value. 43 user> USERNAME 44 45 Option pass. 46 Pikpak password. 47 Choose an alternative below. 48 y) Yes, type in my own password 49 g) Generate random password 50 y/g> y 51 Enter the password: 52 password: 53 Confirm the password: 54 password: 55 56 Edit advanced config? 57 y) Yes 58 n) No (default) 59 y/n> 60 61 Configuration complete. 62 Options: 63 - type: pikpak 64 - user: USERNAME 65 - pass: *** ENCRYPTED *** 66 - token: {"access_token":"eyJ...","token_type":"Bearer","refresh_token":"os...","expiry":"2023-01-26T18:54:32.170582647+09:00"} 67 Keep this "remote" remote? 68 y) Yes this is OK (default) 69 e) Edit this remote 70 d) Delete this remote 71 y/e/d> y 72 ``` 73 74 ### Modification times and hashes 75 76 PikPak keeps modification times on objects, and updates them when uploading objects, 77 but it does not support changing only the modification time 78 79 The MD5 hash algorithm is supported. 80 81 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/pikpak/pikpak.go then run make backenddocs" >}} 82 ### Standard options 83 84 Here are the Standard options specific to pikpak (PikPak). 85 86 #### --pikpak-user 87 88 Pikpak username. 89 90 Properties: 91 92 - Config: user 93 - Env Var: RCLONE_PIKPAK_USER 94 - Type: string 95 - Required: true 96 97 #### --pikpak-pass 98 99 Pikpak password. 100 101 **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/). 102 103 Properties: 104 105 - Config: pass 106 - Env Var: RCLONE_PIKPAK_PASS 107 - Type: string 108 - Required: true 109 110 ### Advanced options 111 112 Here are the Advanced options specific to pikpak (PikPak). 113 114 #### --pikpak-client-id 115 116 OAuth Client Id. 117 118 Leave blank normally. 119 120 Properties: 121 122 - Config: client_id 123 - Env Var: RCLONE_PIKPAK_CLIENT_ID 124 - Type: string 125 - Required: false 126 127 #### --pikpak-client-secret 128 129 OAuth Client Secret. 130 131 Leave blank normally. 132 133 Properties: 134 135 - Config: client_secret 136 - Env Var: RCLONE_PIKPAK_CLIENT_SECRET 137 - Type: string 138 - Required: false 139 140 #### --pikpak-token 141 142 OAuth Access Token as a JSON blob. 143 144 Properties: 145 146 - Config: token 147 - Env Var: RCLONE_PIKPAK_TOKEN 148 - Type: string 149 - Required: false 150 151 #### --pikpak-auth-url 152 153 Auth server URL. 154 155 Leave blank to use the provider defaults. 156 157 Properties: 158 159 - Config: auth_url 160 - Env Var: RCLONE_PIKPAK_AUTH_URL 161 - Type: string 162 - Required: false 163 164 #### --pikpak-token-url 165 166 Token server url. 167 168 Leave blank to use the provider defaults. 169 170 Properties: 171 172 - Config: token_url 173 - Env Var: RCLONE_PIKPAK_TOKEN_URL 174 - Type: string 175 - Required: false 176 177 #### --pikpak-root-folder-id 178 179 ID of the root folder. 180 Leave blank normally. 181 182 Fill in for rclone to use a non root folder as its starting point. 183 184 185 Properties: 186 187 - Config: root_folder_id 188 - Env Var: RCLONE_PIKPAK_ROOT_FOLDER_ID 189 - Type: string 190 - Required: false 191 192 #### --pikpak-use-trash 193 194 Send files to the trash instead of deleting permanently. 195 196 Defaults to true, namely sending files to the trash. 197 Use `--pikpak-use-trash=false` to delete files permanently instead. 198 199 Properties: 200 201 - Config: use_trash 202 - Env Var: RCLONE_PIKPAK_USE_TRASH 203 - Type: bool 204 - Default: true 205 206 #### --pikpak-trashed-only 207 208 Only show files that are in the trash. 209 210 This will show trashed files in their original directory structure. 211 212 Properties: 213 214 - Config: trashed_only 215 - Env Var: RCLONE_PIKPAK_TRASHED_ONLY 216 - Type: bool 217 - Default: false 218 219 #### --pikpak-hash-memory-limit 220 221 Files bigger than this will be cached on disk to calculate hash if required. 222 223 Properties: 224 225 - Config: hash_memory_limit 226 - Env Var: RCLONE_PIKPAK_HASH_MEMORY_LIMIT 227 - Type: SizeSuffix 228 - Default: 10Mi 229 230 #### --pikpak-encoding 231 232 The encoding for the backend. 233 234 See the [encoding section in the overview](/overview/#encoding) for more info. 235 236 Properties: 237 238 - Config: encoding 239 - Env Var: RCLONE_PIKPAK_ENCODING 240 - Type: Encoding 241 - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot 242 243 #### --pikpak-description 244 245 Description of the remote 246 247 Properties: 248 249 - Config: description 250 - Env Var: RCLONE_PIKPAK_DESCRIPTION 251 - Type: string 252 - Required: false 253 254 ## Backend commands 255 256 Here are the commands specific to the pikpak backend. 257 258 Run them with 259 260 rclone backend COMMAND remote: 261 262 The help below will explain what arguments each command takes. 263 264 See the [backend](/commands/rclone_backend/) command for more 265 info on how to pass options and arguments. 266 267 These can be run on a running backend using the rc command 268 [backend/command](/rc/#backend-command). 269 270 ### addurl 271 272 Add offline download task for url 273 274 rclone backend addurl remote: [options] [<arguments>+] 275 276 This command adds offline download task for url. 277 278 Usage: 279 280 rclone backend addurl pikpak:dirpath url 281 282 Downloads will be stored in 'dirpath'. If 'dirpath' is invalid, 283 download will fallback to default 'My Pack' folder. 284 285 286 ### decompress 287 288 Request decompress of a file/files in a folder 289 290 rclone backend decompress remote: [options] [<arguments>+] 291 292 This command requests decompress of file/files in a folder. 293 294 Usage: 295 296 rclone backend decompress pikpak:dirpath {filename} -o password=password 297 rclone backend decompress pikpak:dirpath {filename} -o delete-src-file 298 299 An optional argument 'filename' can be specified for a file located in 300 'pikpak:dirpath'. You may want to pass '-o password=password' for a 301 password-protected files. Also, pass '-o delete-src-file' to delete 302 source files after decompression finished. 303 304 Result: 305 306 { 307 "Decompressed": 17, 308 "SourceDeleted": 0, 309 "Errors": 0 310 } 311 312 313 {{< rem autogenerated options stop >}} 314 315 ## Limitations 316 317 ### Hashes may be empty 318 319 PikPak supports MD5 hash, but sometimes given empty especially for user-uploaded files. 320 321 ### Deleted files still visible with trashed-only 322 323 Deleted files will still be visible with `--pikpak-trashed-only` even after the 324 trash emptied. This goes away after few days.