magento-package-overlay

Nix overlay providing up-to-date Magento development tools.

Packages

Package	Source
n98-magerun2	netz98/n98-magerun2
magento-cache-clean	mage-os/magento-cache-clean
magento-cache-clean-el	emacs-magento/magento-cache-clean.el

Usage

As a flake overlay

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
    magento-overlay.url = "github:codemanufacture/magento-package-overlay";
  };

  outputs = { nixpkgs, magento-overlay, ... }: {
    # NixOS configuration
    nixosConfigurations.myhost = nixpkgs.lib.nixosSystem {
      modules = [
        { nixpkgs.overlays = [ magento-overlay.overlays.default ]; }
      ];
    };

    # Or in a devShell
    devShells.x86_64-linux.default = let
      pkgs = import nixpkgs {
        system = "x86_64-linux";
        overlays = [ magento-overlay.overlays.default ];
      };
    in pkgs.mkShell {
      packages = [ pkgs.n98-magerun2 pkgs.magento-cache-clean ];
    };
  };
}

Emacs package

The magento-cache-clean-el package is available under emacsPackages. To use it with home-manager:

programs.emacs = {
  enable = true;
  extraPackages = epkgs: [ pkgs.magento-cache-clean-el ];
};

Run directly

nix run github:codemanufacture/magento-package-overlay#n98-magerun2
nix run github:codemanufacture/magento-package-overlay#magento-cache-clean

Updates

Packages are automatically checked for updates daily at 06:00 UTC via GitHub Actions. The update script can also be run manually:

./update.sh