Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/pkgforge/pkgcache
Browse files Browse the repository at this point in the history
  • Loading branch information
Azathothas committed Nov 6, 2024
2 parents 69b3038 + 956c646 commit 13f3295
Show file tree
Hide file tree
Showing 58 changed files with 63,547 additions and 62,621 deletions.
26 changes: 13 additions & 13 deletions Docs/METADATA.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
- #### Metadata
> - A Machine Consumable & Automation Friendly dataset is published & kept [`UP To Date`](https://github.com/Azathothas/Toolpacks/actions/workflows/healthchecks_housekeeping.yaml)
> - A Machine Consumable & Automation Friendly dataset is published & kept [`UP To Date`](https://github.com/pkgforge/pkgcache/actions/workflows/healthchecks_housekeeping.yaml)
> - It's available as `JSON`, `TOML` & `YAML`
> > - [aarch64-Linux](https://github.com/pkgforge/pkgcache/blob/main/aarch64-Linux/METADATA.urls)
> > - [x86_64-Linux](https://github.com/pkgforge/pkgcache/blob/main/x86_64-Linux/METADATA.urls)
Expand All @@ -25,15 +25,15 @@
> > ],
> > "pkg" : [
> > {
> > ${Binaries, or rather pkgs are from Toolpacks Extras}
> > ${Binaries, or rather pkgs are from pkgforge/pkgcache}
> > }
> > ]
> > ```
> - [Each of the ${BIN/PKG} contains fields like]:
> > ```YAML
> > name: "#Contains the Name of the $PKG itself, this is NOT what it will/should be Installed as",
> > bin_id: "#Contains the Application ID, usually from appstream files, [Otherwise starts with xxx]",
> > bin_name: "#Contains the real name, the $PKG will be installed as",
> > pkg: "#Contains the Name of the $PKG itself, this is NOT what it will/should be Installed as",
> > pkg_id: "#Contains the Application ID, usually from appstream files, [Otherwise starts with xxx]",
> > pkg_name: "#Contains the real name, the $PKG will be installed as",
> > description: "#Contains the Description of the $PKG/$PKG_FAMILY [Otherwise EMPTY]",
> > note: "#Contains Additional Notes,Refs,Info the user need to be aware of, of the $PKG/$PKG_FAMILY"
> > version: "#Contains the version of the $PKG <AUTOGENERATED>",
Expand All @@ -44,15 +44,15 @@
> > build_date: "#Contains the Exact Date the $PKG was Built(Fetched) & Uploaded",
> > repology: "#Contains Repology Metadata from /api/v1/project/{$PKG/$PKG_FAMILY} [Otherwise EMPTY]",
> > src_url: "#Contains the Github/Gitlab/$GIT_SRC URL of the $PKG/$PKG_FAMILY [Otherwise EMPTY]",
> > web_url: "#Contains the Website/Project Page URL of the $PKG/$PKG_FAMILY [Otherwise EMPTY]",
> > homepage: "#Contains the Website/Project Page URL of the $PKG/$PKG_FAMILY [Otherwise EMPTY]",
> > build_script: "#Contains the Actual Script the $BINARY was Built(Fetched) With <AUTOGENERATED>"
> > build_log: "#Contains the link to view the Actual CI BUILD LOG of the $BINARY <AUTOGENERATED>"
> > appstream: "#Contains the Appstream ({AppData/Metainfo}.xml) File of the $PKG/$PKG_FAMILY (MAY BE INACCURATE) [Otherwise EMPTY]",
> > category: "#Contains the $PKG/$PKG_FAMILY's Category in FreeDesktopSpec [Fallbacks to Utility]"
> > desktop: "#Contains the .Desktop File of the $PKG/$PKG_FAMILY (MAY BE INACCURATE) [Otherwise EMPTY]",
> > icon: "#Contains the Logo/Icon File of the $PKG/$PKG_FAMILY (MAY BE INACCURATE) [Fallbacks to Generic Icon]",
> > screenshots: "#Contains an Array of Screenshots of the $PKG/$PKG_FAMILY (MAY BE INACCURATE) [Otherwise EMPTY]",
> > extra_bins: "#Contains names of related binaries (Only if they belong to same $PKG_FAMILY) of the $PKG/$PKG_FAMILY [Otherwise EMPTY]",
> > provides: "#Contains names of related binaries (Only if they belong to same $PKG_FAMILY) of the $PKG/$PKG_FAMILY [Otherwise EMPTY]",
> > snapshots: "#Contains an Array of Snapshots (Last 3 Version) of the $PKG/$PKG_FAMILY"
> > ```
> >
Expand All @@ -66,7 +66,7 @@
> > #Though, there now exists appimageupdatetool: https://github.com/AppImageCommunity/AppImageUpdate, you can still use zsync manually if you need it
> > "$(.name).zsync" #Example: https://pkg.pkgforge.dev/x86_64/qbittorrent.AppImage.zsync
> > ```
> - You can use this data to automate downloading, updating or even build a full fledged *📦 Package Manager* like [`@QaidVoid/soar`](https://github.com/QaidVoid/soar), [`@xplshn/dbin`](https://github.com/xplshn/dbin) & [`@ivan-hc/AM`](https://github.com/ivan-hc/AM)
> - You can use this data to automate downloading, updating or even build a full fledged *📦 Package Manager* like [`🦀 @QaidVoid/soar`](https://github.com/QaidVoid/soar), [`@xplshn/dbin`](https://github.com/xplshn/dbin)
---
- #### Using [JQ](https://jqlang.github.io/jq/manual/) to Parse [METADATA.json](https://pkg.pkgforge.dev/METADATA.json)
Expand All @@ -77,13 +77,13 @@
> echo "$(uname -m)" #either x86_64 or aarch64
> #---------------------#
> # Append `| jq -r '.$TYPE[].$PROPERTY'` to filter them, for example:
> !# Simple example to: list all Pkgs in .bin
> curl -qfsSL "https://bin.pkgforge.dev/$(uname -m)/METADATA.AIO.json" | jq -r '.pkg[] | .name'
> !# Simple example to: list all Pkgs in .pkg
> curl -qfsSL "https://bin.pkgforge.dev/$(uname -m)/METADATA.AIO.json" | jq -r '.pkg[] | .pkg'
>
> !#To pretty print anything that matches qbittorrent from .pkg
> curl -qfsSL "https://bin.pkgforge.dev/$(uname -m)/METADATA.AIO.json" | jq -r '.pkg[] | select(.name | test("qbittorrent"; "i")) | "---------------------------\n" + (. | to_entries | map("\(.key): \(.value)") | join("\n"))'
> curl -qfsSL "https://bin.pkgforge.dev/$(uname -m)/METADATA.AIO.json" | jq -r '.pkg[] | select(.pkg | test("qbittorrent"; "i")) | "---------------------------\n" + (. | to_entries | map("\(.key): \(.value)") | join("\n"))'
> ```
> ![image](https://github.com/user-attachments/assets/79248a8b-1716-4fec-b021-cc04948f0639)
> ![image](https://github.com/user-attachments/assets/fc3a59c4-74f2-4564-bd12-38ca7eb6c971)
>
---
Expand All @@ -100,4 +100,4 @@
> > curl -qfsSLO "https://pkg.pkgforge.dev/$(uname -m)/$PKG_OR_PATH_TO_PKG"
> >
> > ```
> ![image](https://github.com/user-attachments/assets/26b2fe7a-48ce-4661-b184-13a5e3f3a149)
> ![image](https://github.com/user-attachments/assets/778cfb21-9938-4cbd-b132-cafa84676594)
Loading

0 comments on commit 13f3295

Please sign in to comment.