{"id":15407943,"url":"https://github.com/ryanccn/nyoom","last_synced_at":"2025-04-18T12:28:14.908Z","repository":{"id":180911079,"uuid":"665901296","full_name":"ryanccn/nyoom","owner":"ryanccn","description":"A small Firefox userchrome manager","archived":false,"fork":false,"pushed_at":"2025-04-13T02:46:15.000Z","size":2326,"stargazers_count":33,"open_issues_count":9,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-13T03:40:03.606Z","etag":null,"topics":["cli","firefox","firefox-css","firefox-userchrome","nix-flake","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryanccn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"ko_fi":"ryancaodev"}},"created_at":"2023-07-13T08:53:26.000Z","updated_at":"2025-04-11T06:37:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"8103bc1d-3806-42ac-987b-222e41571f4e","html_url":"https://github.com/ryanccn/nyoom","commit_stats":{"total_commits":174,"total_committers":4,"mean_commits":43.5,"dds":0.2701149425287356,"last_synced_commit":"8739247b9b401039529f40b4999b5eac9ab48170"},"previous_names":["ryanccn/nyoom"],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanccn%2Fnyoom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanccn%2Fnyoom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanccn%2Fnyoom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanccn%2Fnyoom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryanccn","download_url":"https://codeload.github.com/ryanccn/nyoom/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249493153,"owners_count":21281488,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","firefox","firefox-css","firefox-userchrome","nix-flake","rust"],"created_at":"2024-10-01T16:30:17.057Z","updated_at":"2025-04-18T12:28:14.875Z","avatar_url":"https://github.com/ryanccn.png","language":"Rust","funding_links":["https://ko-fi.com/ryancaodev"],"categories":[],"sub_categories":[],"readme":"\u003c!--\nSPDX-FileCopyrightText: 2024 Ryan Cao \u003chello@ryanccn.dev\u003e\n\nSPDX-License-Identifier: CC-BY-NC-SA-4.0\n--\u003e\n\n# nyoom\n\nFirefox userchrome manager, written in [Rust](https://rust-lang.org/).\n\n![Demo](/.github/demo.gif)\n\n## Install\n\n### Nix\n\n#### Flake\n\n```nix\n{\n  inputs = {\n    nyoom = {\n      url = \"github:ryanccn/nyoom\";\n      inputs.nixpkgs.follows = \"nixpkgs\";\n    };\n  };\n\n  outputs =\n    { ... }@inputs:\n    {\n      # ...\n      environment.systemPackages = with pkgs; [\n        inputs.nyoom.packages.${pkgs.system}.nyoom\n      ];\n    };\n}\n```\n\n#### Profile\n\n```bash\n$ nix profile install github:ryanccn/nyoom\n```\n\n### GitHub Releases\n\nYou can download pre-built binaries from [GitHub Releases](https://github.com/ryanccn/nyoom/releases/latest). Builds are available for:\n\n- macOS aarch64, x86_64\n- Linux x86_64, aarch64 (static)\n- Windows x86_64, aarch64 (dynamic, MSVC)\n\n## Usage\n\n### Adding a userchrome\n\nnyoom specifies sources for userchromes in a special format.\n\n- **GitHub**: `github:\u003cowner\u003e/\u003crepo\u003e[#ref]`\n- **Codeberg**: `codeberg:\u003cowner\u003e/\u003crepo\u003e[#ref]`\n- **GitLab**: `gitlab:\u003cowner\u003e/\u003crepo\u003e[#ref]`\n- **URL** (to a known archive format of `.zip`, `.tar`, `.tgz`, `.tar.gz`, `.tar.xz`, `.tar.bz2` or `.tar.zst`): `url:\u003curl\u003e` or just `\u003curl\u003e`\n- **Path** to a directory: `path:\u003cpath\u003e`\n\nYou can add a new userchrome by using the `nyoom add` command:\n\n```bash\n$ nyoom add \u003cname\u003e \u003csource\u003e\n```\n\nThen, to specify config options specific to a userchrome, use the `nyoom config` commands:\n\n```bash\n$ nyoom config set \u003cname\u003e \u003ckey\u003e \u003cvalue\u003e        # value is treated as string\n$ nyoom config set --raw \u003cname\u003e \u003ckey\u003e \u003cvalue\u003e  # value is treated as a JavaScript value\n$ nyoom config unset \u003cname\u003e \u003ckey\u003e\n$ nyoom config list\n```\n\nThese config options will be automatically added to and removed from your `user-overrides.js` (preferred) or `user.js` upon switching.\n\n### Switching\n\nFirst, you need to configure the full path to where your Firefox profile is.\n\n```bash\n$ nyoom profile \u003cdirectory\u003e\n```\n\nThen, run `nyoom switch \u003cname\u003e` to switch to a userchrome you previously added. nyoom will retrieve the source, install the contents of the userchrome in the `chrome` directory, inject settings into `user-overrides.js` or `user.js`, and update arkenfox (thereby syncing `user-overrides.js` with `user.js`) if arkenfox is detected.\n\nYou can run `nyoom update` on subsequent runs to reapply the userchrome using the latest data from remote, and use `nyoom switch out` to uninstall the userchrome.\n\n## License\n\nGPLv3\n\n[![xkcd 2959: Beam of Light](https://imgs.xkcd.com/comics/beam_of_light.png)](https://xkcd.com/2959)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanccn%2Fnyoom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryanccn%2Fnyoom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanccn%2Fnyoom/lists"}