[wiki: Add following page] "Migrating install from local/custom version to official bucket without scoop uninstall"

[goyalyashpal]

Migrating custom installs to upstream buckets without scoop uninstall"

Scenario

i have faced this situation 2 times:

• u have installed some app from local manifest and later it got added in official buckets, so u need to migrate it to there
  beeref: Add version 0.3.3 Extras#13124
• u installed some explicitly specified older version of an app for some reason and now need to update it normally
  how to update those installed via `app@version` ?? #5954

i.e.

> scoop install local_bucket/my-app
> scoop install ./path/to/my-app.json
> scoop install main/my-app@version

and no, neither of scoop install <intended-bucket>/<app> or scoop update <intended-bucket>/<app> --force will solve this.

Steps & Summary

• to update the installs from these above cases to <intended-bucket>/<app>,
  change the key-value in install.json file in $(scoop prefix <app>) directory to "bucket": "<intended-bucket>".
  and remove the "url": key-value pair
• programmatically, it can be done in following way in bash. (steps took from SO: q/42716734)
• powershell script is left as an exercise to the reader 😜

# See current contents of the file; 
# Run this BOTH before AND after editing
bat -p "$(scoop prefix <app>)/install.json"

# Specifying values that we want
mybucket="<intended-bucket>"

myapp="<app>"
myfile="$(scoop prefix $myapp)/install.json"

# Changing the contents of the `install.json` file
tmp=$(mktemp)
jq '.bucket = $ARGS.named.mybucket | del(.url)' "$myfile" --arg mybucket $mybucket > "$tmp" && mv -v "$tmp" "$myfile"

Illustration Cases

... moved in first comment below ...

[goyalyashpal]

Illustration Cases

... moved in first comment below ...

For brevity, Only relevant fields are show in output

1. Beeref (from local bucket to extras bucket)

Note the Installed, Updated at and Notes field in both these.

$ # Before `scoop update`; 
$ scoop info beeref

Name        : beeref
Version     : 0.3.3
Bucket      : local
Updated at  : 2024-05-11 09:07:42
Installed   : 0.3.2
              0.3.3
Notes       : %APPDATA%/BeeRef

$ # After `scoop update`, Before changing `install.json`
$ scoop info beeref

Name        : beeref
Version     : 0.3.3
Bucket      : extras
Updated at  : 2024-05-12 xx:xx:xx
Notes       : Settings are stored in '%APPDATA%\BeeRef', and are not persisted by
              Scoop.

$ scoop list beeref
Installed apps matching 'beeref':

Name   Version Source Updated             Info
----   ------- ------ -------             ----
beeref 0.3.3   local  2024-05-11 09:10:01

$ scoop update beeref -f
beeref: 0.3.3 -> 0.3.3
  ...
Updating one outdated app:
Updating 'beeref' (0.3.3 -> 0.3.3)
  ...
Checking hash of BeeRef-0.3.3.exe ... ok.
  ...
Installing 'beeref' (0.3.3) [64bit] from 'local' bucket
  ...
'beeref' (0.3.3) was installed successfully!
Notes
-----
%APPDATA%/BeeRef

Changing the install.json file:

$ bat -p $(scoop prefix beeref)/install.json
{
    "bucket": "local",
    "architecture": "64bit"
}

$ myfile="$(scoop prefix beeref)/install.json"
$ tmp=$(mktemp)

$ jq '.bucket = "extras"' "$myfile" > "$tmp" && mv -v "$tmp" "$myfile"
renamed '/tmp/tmp.PGilmI4NtO' -> 'D:\UserFiles\scoop\apps\beeref\current/install.json'

$ bat -p $(scoop prefix beeref)/install.json
{
    "bucket": "extras",
    "architecture": "64bit"
}

Verifying it works after the changes

$ # After updating the `install.json`
$ scoop list beeref
Installed apps matching 'beeref':

Name   Version Source Updated             Info
----   ------- ------ -------             ----
beeref 0.3.3   extras 2024-05-12 xx:xx:xx

$ # --force is used here only as the version number is same for both
$ scoop update beeref -f
beeref: 0.3.3 -> 0.3.3
  ...
Updating one outdated app:
Updating 'beeref' (0.3.3 -> 0.3.3)
  ...
Checking hash of BeeRef-0.3.3.exe ... ok.
  ...
Installing 'beeref' (0.3.3) [64bit] from 'extras' bucket
  ...
'beeref' (0.3.3) was installed successfully!
Notes
-----
Settings are stored in '%APPDATA%\BeeRef', and are not persisted by Scoop.

$ scoop info beeref

Name        : beeref
Updated at  : 2024-05-12 xx:xx:xx
Installed   : 0.3.2
              0.3.3
Notes       : Settings are stored in '%APPDATA%\BeeRef', and are not persisted by
              Scoop.

2. usql (from custom version to normal updates)

$ scoop info usql

Name        : usql
Version     : 0.19.1
Bucket      : main
Website     : https://github.com/xo/usql
License     : MIT
Updated at  : 2024-05-12 xx:xx:xx

Getting the list of last 5 versions

$ repo="xo/usql"

$ curl -L --silent "https://api.github.com/repos/$repo/releases" | jq '[.[].tag_name][range(0;5)]'
"v0.19.1"
"v0.19.0"
"v0.18.1"
"v0.18.0"
"v0.17.5"

Installing an older version

$ scoop install usql@0.18.0
Updating Scoop...
  ...
WARN  Given version (0.18.0) does not match manifest (0.19.1)
WARN  Attempting to generate manifest for 'usql' (0.18.0)
Autoupdating usql
  ...
Downloading usql-0.18.0-windows-amd64.zip to compute hashes!
usql-0.18.0-windows-amd64.zip (37.9 MB)
  ...
Loading usql-0.18.0-windows-amd64.zip from cache.
Checking hash of usql-0.18.0-windows-amd64.zip ... ok.
  ...
Creating shim for 'usql'.
'usql' (0.18.0) was installed successfully!

Checking it won't update normally now & no "Installed" in scoop info

$ scoop list usql
Installed apps matching 'usql':

Name Version Source           Updated             Info
---- ------- ------           -------             ----
usql 0.18.0  <auto-generated> 2024-05-12 11:54:44

$ scoop info usql

Name        : usql
Version     : 0.19.1
Bucket      : main
Updated at  : 2024-05-12 xx:xx:xx

$ scoop update main/usql -f
usql: 0.18.0 -> 0.18.0
  ...
Installing 'usql' (0.18.0) [64bit] from 'D:\UserFiles\scoop\workspace\usql.json'
  ...
'usql' (0.18.0) was installed successfully!

Investigating the install.json

$ mybucket="main"
$ myapp="usql"

$ myfile="$(scoop prefix $myapp)/install.json"
$ bat -p "$myfile"
{
    "url": "D:\\UserFiles\\scoop\\workspace\\usql.json",
    "architecture": "64bit"
}

$ jq '.bucket = $ARGS.named.mybucket' "$myfile" --arg mybucket $mybucket
{
  "url": "D:\\UserFiles\\scoop\\workspace\\usql.json",
  "architecture": "64bit",
  "bucket": "main"
}

Changing the install.json (i.e. fixing things)

$ echo -e "$myapp \n$mybucket \n$tmp"; echo "$myfile"
usql
main
/tmp/tmp.jEzb9dTVQr
D:\UserFiles\scoop\apps\usql\current/install.json

$ jq '.bucket = $ARGS.named.mybucket | del(.url)' "$myfile" --arg mybucket $mybucket > "$tmp" && mv -v "$tmp" "$myfile"
renamed '/tmp/tmp.jEzb9dTVQr' -> 'D:\UserFiles\scoop\apps\usql\current/install.json'

Verifying that it accomplished what we wanted successfully 😃

$ scoop list usql
Installed apps matching 'usql':

Name Version Source Updated             Info
---- ------- ------ -------             ----
usql 0.18.0  main   2024-05-12 12:27:44

$ scoop info usql

Name        : usql
Version     : 0.18.0 (Update to 0.19.1 available)
Bucket      : main
Updated at  : 2024-05-12 xx:xx:xx
Installed   : 0.18.0

$ scoop update usql
usql: 0.18.0 -> 0.19.1
  ...
Updating one outdated app:
Updating 'usql' (0.18.0 -> 0.19.1)
  ...
Download: (OK):download completed.
Checking hash of usql-0.19.1-windows-amd64.zip ... ok.
  ...
Installing 'usql' (0.19.1) [64bit] from 'main' bucket
Loading usql-0.19.1-windows-amd64.zip from cache.
  ...
'usql' (0.19.1) was installed successfully!