Make GitHub PAT and CF API key have a global flag and env var

Author: theRookieCoder

.github/workflows/build.yml

@@ -5,7 +5,7 @@ on:
     commits:
     paths:
       - "**.rs"
-      - "**.yml"
+      - ".github/workflows/build.yml"
       - "Cargo.lock"
       - "Cargo.toml"
       - "justfile"

.github/workflows/release.yml

@@ -52,9 +52,9 @@ jobs:
 
             The provided binaries are for:
             - Linux (x64 linux musl)
-            - Linux without a GUI file dialogue and libraries
+            - Linux without a GUI file dialogue
             - Linux ARM (aarch64 linux musl)
-            - Linux ARM without a GUI file dialogue and libraries
+            - Linux ARM without a GUI file dialogue (works in Termux!)
             - macOS Apple Silicon (aarch64 darwin)
             - macOS Intel (x64 darwin)
             - GNU Windows (x64 windows gnu) (i.e. Cygwin/MinGW)

CHANGELOG.md

@@ -5,6 +5,7 @@
 
 - Fix [#184](https://github.com/gorilla-devs/ferium/issues/184), switch all linux builds to use `musl`
 - Fix [#134](https://github.com/gorilla-devs/ferium/issues/134), add arm builds for linux
+- Make both the GitHub PAT and custom CF API key have a global flag and environment variable
 
 ## `v4.1.11`
 ### 02.10.2022

README.md

@@ -4,16 +4,16 @@
 [![license badge](https://img.shields.io/github/license/theRookieCoder/ferium?style=for-the-badge)](https://github.com/theRookieCoder/ferium/blob/main/LICENSE.txt)
 [![copyleft badge](https://img.shields.io/static/v1?label=&message=Copyleft&style=for-the-badge&labelColor=silver&color=silver&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAQAAAC0NkA6AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfjAxYBNgYPa+9oAAAEM0lEQVRYw6WYb0zVVRjHP9wQW7umA0xoKNSC+6bSNkzetKZbaVu19aLpfOGcbcw/S+uNbikuNwMsVyE3XVsro7VEXjS3ylmLxkRtC9crHGjCAv9AATK4CoZye8Hl/J7n/M7v8rvX57w55/lznt/583yf5/xyCEOlrKaSCp6ggCiQYJheLvMHv9HHA1MZ++kmmaZ1UUNZ9g6eo4X7aR3Mtvs0syJzB0U0MR3KgddOsiQTFxsZzdDBTLvFetd0OT5OHo1U+7j9tNJBN4MkgChFVLCS1Sz1aR7jHf5Lv4Yov1hfN8YRKgP1V9LIuGVxhmg6Fwv4XalPcJD8OTe3gA+YVHYXgt3kWato46nQp1jOWWs1eW7Fz5VaLbkZ3cdc6pX9UfeNkvd+a1aRtV3Fle+mLeGWEO/0mT/EWo7SxhBjjNDPKfbxtMPNVjHLKMVa+I0Q1lmG89nDTWdctPGqz80hIT+uAWRaGOqzeJEraQOw2YrzXNqNbJrlnqDFsCeJKZO3uDtnnN+wNq6cCSM74SGtd1wHlfrOkHAyyDPKrk5codIZ1n7DSlAoVF9iKjRq/cVCYZnPmJHsnWF1GcYRobiQf3yA3sr7VPM2cXp9br5Va2k0/EsAy4SixKh6a5LT6rQibGBAyaeV9SohWQabzeBvhUcTaoqPHHhdTKfSOaWk1wx/E8TN4CuhssW6pjnOCF/KiNrOxULWZPgNEbEJF4VKFT2mdbGLpNNJPzVqC9eKkTdbDK4ajy9ngVaPiHuU5AshWWe4VyIsMuwbWTi5Q7sYlYj+TdNbFBHpJZEV8vao8sOjMS8VRh64MkumrRhSh5UQ+T278s+jQdF/1PTGI4yaweNZuHiYF1RsyCiapdFcengyNajgZyP4RBhP8RpDAU42KcxqE30vNK7KYJQpploFY1NgnfmvApYiZxpskLAi6/PFVh454HBRyJ9K5yclvS5hJQggP7YA8vvZzJCi1+m3NKoUYnj8Eg31jSonDFuTTPEju9nIZuq55IP6FvUJ3iF0zjBqApLWOu6FTlp9FCgM90rX9/zpt1Z9z56QLkasatnLRfe8TT5pmHetQqI6RAoesB5A5aIy/s5jrxAl0VmrJHqFvrQuflCwCPM4Jy71s1L0tTA75IPzAyo5ea3D8eg5LORf2mWqnGaXz3Q+b3CcDm6nCtBfqeV5R+xsUyf1mC3eoBLp9qzAcocquN90qRxTW/Fhxk+Hw8o+HvQIOqPU2qkI7SLGeauAmhf8YrygVCepU0HmpkLqLaQ7nz43Ra3VJBknzqpA/SrivofpaduF64n9Kdt83OupJ/YA48ACiolRyRpHovuMd5kKs8PrA+JirjbsvlFBlE9DyP8qXnQ3+eNiblpOc+gfOCc0gGRGpeyzymq7dbLXSmch/q24qIQ1VBKjjMLUT7UheunmIq2qQgmg/wHquM6d9tIV7AAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAxOS0wMy0yMlQwMTo1NDowNiswMDowMOIizoUAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMTktMDMtMjJUMDE6NTQ6MDYrMDA6MDCTf3Y5AAAAAElFTkSuQmCC)](https://en.wikipedia.org/wiki/Copyleft)
 
-> Check out Ferium's sister projects [Ferinth](https://github.com/theRookieCoder/ferinth) and [Furse](https://github.com/theRookieCoder/furse).
-> They are Rust wrappers for the Modrinth and CurseForge APIs respectively
+> Check out ferium's sister projects [ferinth](https://github.com/theRookieCoder/ferinth) and [furse](https://github.com/theRookieCoder/furse).
+> They are Rust wrappers for the official Modrinth and CurseForge APIs respectively
 
 Ferium is a fast and feature rich CLI program for downloading and updating Minecraft mods from [Modrinth](https://modrinth.com/mods), [CurseForge](https://curseforge.com/minecraft/mc-mods), and [GitHub Releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases), and modpacks from [Modrinth](https://modrinth.com/modpacks) and [CurseForge](https://curseforge.com/minecraft/modpacks).
 Simply specify the mods or modpacks you use through the CLI, and in just one command you can the download all the mods or the modpack you configured.
 
 ## Features
 
 - Download mods from multiple sources, namely [Modrinth](https://modrinth.com/mods), [CurseForge](https://curseforge.com/minecraft/mc-mods), and [GitHub Releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases)
-- Download modpacks from multiple sources, namely [Modrinth](https://modrinth.com/modpacks), [CurseForge](https://curseforge.com/minecraft/modpacks)
+- Download modpacks from multiple sources, namely [Modrinth](https://modrinth.com/modpacks) and [CurseForge](https://curseforge.com/minecraft/modpacks)
 - Pleasing and beautiful UI
   - Listing mods
     ![Listing Mods](media/list.png)
@@ -22,7 +22,7 @@ Simply specify the mods or modpacks you use through the CLI, and in just one com
   - Upgrading mods/modpacks
     ![Upgrading Mods/Modpacks](media/upgrade.png)
 - [It's super fast](https://www.reddit.com/r/rust/comments/umcu1j/media_ferium_the_cli_minecraft_mod_manager) due to multi-threading for network intensive tasks
-  - You can configure the maximum number of additional threads using the `--threads` options
+  - Of course, the real world speed still depends on your internet connection
 - Upgrade all your mods in one command, `ferium upgrade`
   - Ferium checks that the version being downloaded is the latest one compatible with the chosen mod loader and Minecraft version
   - You can configure overrides for mods that are not specified as compatible but still work
@@ -32,18 +32,20 @@ Simply specify the mods or modpacks you use through the CLI, and in just one com
 ## Installation
 
 Ferium is a compiled, statically linked program that does not require external dependencies.
-However, Rust programs in general require `gcc-libs` to be installed on Linux.
-On Linux the regular version requires GTK, but the `no-gui` version does not need this.
+On Linux, the regular version requires some sort of desktop environment that offers an XDG Desktop Portal. The `nogui` versions do not need this.
 
 Ferium is coming to more package managers soon!
 [Tracking Issue](https://github.com/theRookieCoder/ferium/issues/42)
 
-### AUR (Arch Linux)
+### Arch User Repository (Arch Linux)
 
+- [GUI](https://aur.archlinux.org/packages/ferium-gui-bin)
+- [GUI from Source](https://aur.archlinux.org/packages/ferium-gui-git)
 - [No GUI](https://aur.archlinux.org/packages/ferium-bin)
-- [No GUI from Source](https://aur.archlinux.org/packages/ferium-git) (installs the Rust toolchain)
-- [GUI File Dialogue](https://aur.archlinux.org/packages/ferium-gui-bin) (depends on GTK)
-- [GUI File Dialogue from Source](https://aur.archlinux.org/packages/ferium-gui-git) (install the Rust toolchain and depends on GTK)
+- [No GUI from Source](https://aur.archlinux.org/packages/ferium-git)
+
+From source builds will install the Rust toolchain.
+GUI builds require any XDG compatible desktop environment to be available at runtime.
 
 ### Scoop (Windows)
 
@@ -57,11 +59,15 @@ Available [here](https://pacstall.dev/packages/ferium-bin)
 
 Run `pacstall -I ferium-bin` to install.
 
+### Nix Packages
+
+Available [here](https://search.nixos.org/packages?channel=unstable&show=ferium&query=ferium) in the unstable channel.
+
 ### Cargo Install (Cross Platform)
 
-If you have the Rust toolchain installed, you can compile and install Ferium from source by running `cargo install ferium`.
+If you have the Rust toolchain installed, you can compile and install ferium from source by running `cargo install ferium`.
 
-Remember to use an add-on like [cargo-update](https://crates.io/crates/cargo-update) to keep Ferium updated to the latest version!
+Remember to use an add-on like [cargo-update](https://crates.io/crates/cargo-update) to keep ferium updated to the latest version!
 
 ### GitHub Releases (Manual - Cross Platform)
 
@@ -71,12 +77,12 @@ Remember to use an add-on like [cargo-update](https://crates.io/crates/cargo-upd
 
 ## Overview / Help Page
 
-> Note! A lot of Ferium's backend is in a seperate project [Libium](https://github.com/theRookieCoder/libium).
+> Note! A lot of ferium's backend is in a seperate project [libium](https://github.com/theRookieCoder/libium).
 > It deals with things such as the config, adding mod(pack)s, upgrading, file pickers, etc
 
 Ferium stores profile and modpack information in it's config file. By default it is located at `~/.config/ferium/config.json`, but you can change this in 2 ways. You can set the `FERIUM_CONFIG_FILE` environment variable or set the `--config-file` global command flag, the flag always takes precedence.
 
-You can also set a custom CurseForge API Key using the `CURSEFORGE_API_KEY` environment variable.
+You can also set a custom CurseForge API key or GitHub personal access token using the `CURSEFORGE_API_KEY` and `GITHUB_TOKEN` environment variables or the `--curseforge_api_key` and `--github-token` flags respectively. Again, the flags take precedence.
 
 ### First Startup
 
@@ -108,9 +114,9 @@ You can either have your own set of mods in what is called a 'profile', or insta
     - For example [Sodium's repository](https://github.com/CaffeineMC/sodium-fabric) has the id `CaffeineMC/sodium-fabric`
     - You can find these at the top left part of the repository's page as a big 'owner / name'
   - So to add [Sodium](https://github.com/CaffeineMC/sodium-fabric), you should run `ferium add CaffeineMC/sodium-fabric` (again, case-insensitive)
-  - Note: The GitHub repository has to release JAR files in their Releases for Ferium to download, or else it will refuse to be added
+  - Note: The GitHub repository has to release JAR files in their Releases for ferium to download, or else it will refuse to be added
 - External mods
-  - If you want to use files that are not downloadable by Ferium, place them in the `user` folder in the output directory. Files here will be copied to the output directory when upgrading
+  - If you want to use files that are not downloadable by ferium, place them in the `user` folder in the output directory. Files here will be copied to the output directory when upgrading
 
 ### Adding Modpacks
 
@@ -129,25 +135,25 @@ You can either have your own set of mods in what is called a 'profile', or insta
 
 ### Upgrading Mods
 
-> If your output directory is not empty when setting it, Ferium will offer to create a backup. Please do so if it contains any files you would like to keep
+> If your output directory is not empty when setting it, ferium will offer to create a backup. Please do so if it contains any files you would like to keep
 
 Now after adding all your mods, run `ferium upgrade` to download all of them to your output directory.
 This defaults to `.minecraft/mods`, where `.minecraft` is the default Minecraft resources directory. You don't need to worry about this if you play with Mojang's launcher (unless you changed the resources directory).
 You can choose to pick a custom output directory during profile creation or [change it later](#profiles).
 
-If Ferium fails to download a mod, it will print it's name in red and give the reason. It will continue downloading the rest of the mods and will exit with an error.
+If ferium fails to download a mod, it will print it's name in red and give the reason. It will continue downloading the rest of the mods and will exit with an error.
 
-**WARNING:** _When upgrading, any files not downloaded by Ferium will be moved to the `.old` folder in the output directory_
+**WARNING:** _When upgrading, any files not downloaded by ferium will be moved to the `.old` folder in the output directory_
 
 ### Upgrading Modpacks
 
-> If your output directory's `mods` and `resourcepacks` sre not empty when setting it, Ferium will offer to create a backup. Please do so if it contains any files you would like to keep
+> If your output directory's `mods` and `resourcepacks` sre not empty when setting it, ferium will offer to create a backup. Please do so if it contains any files you would like to keep
 
 Now after adding all your mods, run `ferium modpack upgrade` to download the modpack to your output directory.
 This defaults to `.minecraft`, which is the default Minecraft resources directory. You don't need to worry about this if you play with Mojang's launcher (unless you changed the resources directory).
 You can choose to pick a custom output directory when adding modpacks or [change it later](#managing-modpacks).
 
-If Ferium fails to download a mod, it will print it's name in red and give the reason. It will continue downloading the rest of the mods and will exit with an error.
+If ferium fails to download a mod, it will print it's name in red and give the reason. It will continue downloading the rest of the mods and will exit with an error.
 
 **WARNING:** _If you choose to install modpack overrides, your existing configs may be overwritten_
 
@@ -160,7 +166,7 @@ You can also provide the names of the mods to remove as arguments. Mod names wit
 
 #### Check Overrides
 
-If some mod is compatible with your profile but Ferium does not download it, [create an issue]((https://github.com/theRookieCoder/ferium/issues/new)) if you think it's a bug. You can disable the game version or mod loader checks by using the `--dont-check-game-version` and/or `--dont-check-mod-loader` flags when adding the mod, or manually setting `check_game_version` or `check_mod_loader` to false for the specific mod in the config.
+If some mod is compatible with your profile but ferium does not download it, [create an issue]((https://github.com/theRookieCoder/ferium/issues/new)) if you think it's a bug. You can disable the game version or mod loader checks by using the `--dont-check-game-version` and/or `--dont-check-mod-loader` flags when adding the mod, or manually setting `check_game_version` or `check_mod_loader` to false for the specific mod in the config.
 
 For example, [Just Enough Items](https://www.curseforge.com/minecraft/mc-mods/jei) does not specify the mod loader for older minecraft versions such as `1.12.2`. In this case, you would add JEI by running `ferium add 238222 --dont-check-mod-loader` so that the mod loader check is disabled.
 You can also manually disable the mod loader (and/or game version) check(s) in the config like so
@@ -227,7 +233,7 @@ Delete a profile by running `ferium profile delete` and selecting the profile yo
 
 If you would like to make a feature request, check the [issues](https://github.com/theRookieCoder/ferium/issues?q=is%3Aissue) to see if the feature has already been added or is planned. If not, [create a new issue](https://github.com/theRookieCoder/ferium/issues/new).
 
-## Building from Source or Working on Ferium
+## Building from Source or Working on ferium
 
 Firstly, you need the Rust toolchain which includes `cargo`, `rustup`, etc. You can install these from [the Rust website](https://www.rust-lang.org/tools/install).
 You'll also need the [`just`](https://github.com/casey/just#installation) command runner, which is basically a much better version of `make`.

src/cli.rs

@@ -16,11 +16,16 @@ pub struct Ferium {
     /// The limit for additional threads spawned by the Tokio runtime
     pub threads: Option<usize>,
     #[clap(long)]
-    /// A GitHub personal access token for increasing the GitHub API rate limit
+    /// Set a GitHub personal access token for increasing the GitHub API rate limit.
+    /// You can also use the environment variable `GITHUB_TOKEN`
     pub github_token: Option<String>,
     #[clap(long)]
-    /// Set the file to read the config from. Does not change the cache and tmp directories
+    /// Set a custom CurseForge API key.
+    /// You can also use the environment variable `CURSEFORGE_API_KEY`
+    pub curseforge_api_key: Option<String>,
+    #[clap(long)]
     #[clap(value_hint(ValueHint::FilePath))]
+    /// Set the file to read the config from. Does not change the cache and tmp directories
     pub config_file: Option<PathBuf>,
 }
 

src/main.rs

@@ -84,9 +84,15 @@ async fn actual_main(cli_app: Ferium) -> Result<()> {
     let github = Arc::new(
         cli_app
             .github_token
-            .map_or_else(OctocrabBuilder::new, |token| {
-                OctocrabBuilder::new().personal_token(token)
-            })
+            .map_or_else(
+                || {
+                    var("GITHUB_TOKEN").map_or_else(
+                        |_| OctocrabBuilder::new(),
+                        |token| OctocrabBuilder::new().personal_token(token),
+                    )
+                },
+                |token| OctocrabBuilder::new().personal_token(token),
+            )
             .build()?,
     );
     let modrinth = Arc::new(Ferinth::new(
@@ -95,11 +101,12 @@ async fn actual_main(cli_app: Ferium) -> Result<()> {
         Some("theRookieCoder#1287"),
         None,
     )?);
-    // Yes this is a personal API key, but I am allowed to write it in source.
-    // The reason is the API key is used for tracking usage, it's not for authentication.
-    // So please don't use this outside of Ferium, although telling you not to is all I can do...
-    let curseforge = Arc::new(Furse::new(&var("CURSEFORGE_API_KEY").unwrap_or_else(
-        |_| "$2a$10$QbCxI6f4KxEs50QKwE2piu1t6oOA8ayOw27H9N/eaH3Sdp5NTWwvO".into(),
+    let curseforge = Arc::new(Furse::new(&cli_app.curseforge_api_key.unwrap_or_else(
+        || {
+            var("CURSEFORGE_API_KEY").unwrap_or_else(|_| {
+                "$2a$10$QbCxI6f4KxEs50QKwE2piu1t6oOA8ayOw27H9N/eaH3Sdp5NTWwvO".into()
+            })
+        },
     )));
 
     let mut config_file = config::get_file(
@@ -205,7 +212,9 @@ async fn actual_main(cli_app: Ferium) -> Result<()> {
                                     .collect::<Vec<_>>(),
                             )
                             .await?;
-                        for (project, team_members) in mr_projects.into_iter().zip(mr_teams_members.into_iter()) {
+                        for (project, team_members) in
+                            mr_projects.into_iter().zip(mr_teams_members.into_iter())
+                        {
                             tasks.push(spawn(subcommands::list::modrinth(project, team_members)));
                         }
                     }

tests/util.rs

@@ -4,7 +4,7 @@ use std::fs::{copy, create_dir};
 use std::io::Result;
 
 pub fn run_command(args: Vec<&str>, config_file: Option<&str>) -> Result<()> {
-    let mut args = args; // Borrow checker bug (I think)
+    let mut args = args;
     let running = format!("./tests/configs/running/{}.json", rand::random::<u16>());
     if let Some(config_file) = config_file {
         let _ = create_dir("./tests/configs/running");
@@ -14,10 +14,6 @@ pub fn run_command(args: Vec<&str>, config_file: Option<&str>) -> Result<()> {
 
     let mut command = Command::new(env!("CARGO_BIN_EXE_ferium"));
     let mut arguments = Vec::new();
-    if let Some(token) = option_env!("GITHUB_TOKEN") {
-        arguments.push("--github-token");
-        arguments.push(token);
-    }
     arguments.push("--config-file");
     arguments.push(&running);
     arguments.append(&mut args);