feat: add nix flake (for nix & nixos users) with package, overlay, and home-manager module

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: Node.js CI
+
+on:
+  workflow_dispatch: 
+  push:
+    branches: [ main feat/multi-account ]
+  pull_request:
+    branches: [ main feat/multi-account ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run typecheck
+    - run: npm run build
+    - run: npm test

.gitignore

@@ -6,3 +6,4 @@ dist/
 coverage/
 *.log
 .DS_Store
+.result

README.md

@@ -11,7 +11,7 @@ Use Claude, ChatGPT, DeepSeek, and 8 more AI models — completely free, zero AP
 [TypeScript](https://www.typescriptlang.org/)
 [Tests](#testing)
 
-[Quick Start](#quick-start) · [Supported Models](#supported-models) · [Configuration](#configuration) · [API Reference](#api-reference) · [Contributing](#contributing)
+[Quick Start](#quick-start) · [Supported Models](#supported-models) · [Configuration](#configuration) · [API Reference](#api-reference) · [Nix / NixOS](#nix--nixos) · [Contributing](#contributing)
 
 
 
@@ -249,6 +249,87 @@ curl http://localhost:3456/v1/messages \
 └──────────────────────────────┘
 ```
 
+## Nix / NixOS
+
+The flake exposes a package, an overlay, and a home-manager module.
+
+### Try it without installing
+
+```bash
+nix run github:linuxhsj/WebModel
+```
+
+### Add to your flake
+
+```nix
+# flake.nix
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    home-manager = {
+      url = "github:nix-community/home-manager";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+    web-model-bridge = {
+      url = "github:linuxhsj/WebModel";
+      inputs.nixpkgs.follows = "nixpkgs"; # reuse your nixpkgs — no extra instance
+    };
+  };
+
+  outputs = { nixpkgs, home-manager, web-model-bridge, ... }: {
+    nixosConfigurations.myhost = nixpkgs.lib.nixosSystem {
+      system = "x86_64-linux";
+      modules = [
+        # 1. Inject the overlay so pkgs.web-model-bridge is available everywhere
+        { nixpkgs.overlays = [ web-model-bridge.overlays.default ]; }
+
+        home-manager.nixosModules.home-manager
+        {
+          home-manager.users.alice = {
+            imports = [ web-model-bridge.homeManagerModules.default ];
+
+            # 2. Enable the module — the package comes from pkgs via the overlay
+            programs.web-model-bridge = {
+              enable  = true;
+              port    = 3456;        # default
+              host    = "127.0.0.1"; # default
+              # configFile = ./webmodel.yml;   # optional YAML config
+              # extraArgs  = [ "--no-open" ];  # optional extra CLI flags
+            };
+          };
+        }
+      ];
+    };
+  };
+}
+```
+
+The home-manager module:
+- Adds `web-model-bridge` to `home.packages` (binary in `$PATH`)
+- Creates a **systemd user service** (`systemctl --user start web-model-bridge`) that auto-starts the server on login
+
+### Available module options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `enable` | bool | `false` | Enable the module |
+| `package` | package | `pkgs.web-model-bridge` | Override the package |
+| `port` | port | `3456` | Listening port |
+| `host` | string | `"127.0.0.1"` | Bind address |
+| `configFile` | path \| null | `null` | Path to YAML config file |
+| `extraArgs` | list of string | `[]` | Extra CLI arguments |
+
+### Just the overlay (without home-manager)
+
+```nix
+{ nixpkgs.overlays = [ web-model-bridge.overlays.default ]; }
+
+# then anywhere in your config:
+environment.systemPackages = [ pkgs.web-model-bridge ];
+```
+
+---
+
 ## Troubleshooting
 
 

flake.nix

@@ -0,0 +1,182 @@
+{
+  description = "web-model-bridge — bridge web AI models through an OpenAI-compatible API";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+    home-manager = {
+      url = "github:nix-community/home-manager";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+
+  outputs = {
+    self,
+    nixpkgs,
+    flake-utils,
+    home-manager,
+  }: let
+    # ── package definition ────────────────────────────────────────────────
+    # Accepts the pkgs set so we can reuse it from any nixpkgs instance.
+    mkWebModelBridge = pkgs:
+      pkgs.buildNpmPackage {
+        pname = "web-model-bridge";
+        version = "0.1.0";
+
+        src = ./.;
+
+        # Run `nix build` once with a fake hash, let nix tell you the real one,
+        # then replace the placeholder below.
+        npmDepsHash = "sha256-wHoZ9lUMtXQ8LhSCQCc30d9K7+ByfrF6/BS3B1PVvt0=";
+
+        # tsup produces a single ESM bundle; makeWrapper creates the bin wrapper.
+        nativeBuildInputs = [pkgs.nodejs_22 pkgs.makeWrapper];
+
+        # The npm "build" script runs tsup.
+        # buildNpmPackage runs `npm run build` by default when a build script exists.
+
+        # Copy the dashboard static files that tsup's onSuccess hook normally handles.
+        postBuild = ''
+          mkdir -p dist/dashboard
+          for f in src/dashboard/index.html src/dashboard/app.js src/dashboard/style.css; do
+            [ -f "$f" ] && cp "$f" dist/dashboard/ || true
+          done
+        '';
+
+        installPhase = ''
+          runHook preInstall
+
+          mkdir -p $out/lib/web-model-bridge
+          cp -r dist $out/lib/web-model-bridge/
+
+          # Keep node_modules for runtime requires (playwright-core etc.)
+          cp -r node_modules $out/lib/web-model-bridge/
+
+          mkdir -p $out/bin
+          makeWrapper ${pkgs.nodejs_22}/bin/node $out/bin/web-model-bridge \
+            --add-flags "$out/lib/web-model-bridge/dist/cli.js"
+
+          runHook postInstall
+        '';
+
+        meta = {
+          description = "Bridge web AI models through an OpenAI-compatible API";
+          license = pkgs.lib.licenses.mit;
+          mainProgram = "web-model-bridge";
+        };
+      };
+
+    # ── overlay ───────────────────────────────────────────────────────────
+    overlay = final: _prev: {
+      web-model-bridge = mkWebModelBridge final;
+    };
+
+    # ── home-manager module ───────────────────────────────────────────────
+    homeManagerModule = {
+      config,
+      lib,
+      pkgs,
+      ...
+    }: let
+      cfg = config.programs.web-model-bridge;
+    in {
+      options.programs.web-model-bridge = {
+        enable = lib.mkEnableOption "web-model-bridge OpenAI-compatible web AI proxy";
+
+        package = lib.mkOption {
+          type = lib.types.package;
+          # Resolved from pkgs, which already has the overlay applied by
+          # the consumer — no second nixpkgs instance needed.
+          default = pkgs.web-model-bridge;
+          defaultText = lib.literalExpression "pkgs.web-model-bridge";
+          description = "The web-model-bridge package to use.";
+        };
+
+        port = lib.mkOption {
+          type = lib.types.port;
+          default = 3000;
+          description = "Port the server listens on.";
+        };
+
+        host = lib.mkOption {
+          type = lib.types.str;
+          default = "127.0.0.1";
+          description = "Host the server binds to.";
+        };
+
+        configFile = lib.mkOption {
+          type = lib.types.nullOr lib.types.path;
+          default = null;
+          description = "Path to a YAML config file (passed via --config).";
+        };
+
+        extraArgs = lib.mkOption {
+          type = lib.types.listOf lib.types.str;
+          default = [];
+          description = "Extra arguments to pass to the web-model-bridge CLI.";
+        };
+      };
+
+      config = lib.mkIf cfg.enable {
+        # Make the binary available in the user's PATH.
+        home.packages = [cfg.package pkgs.google-chrome];
+
+        # Optionally wire up a systemd user service so the server starts
+        # automatically on login.
+        systemd.user.services.web-model-bridge = {
+          Unit = {
+            Description = "web-model-bridge OpenAI-compatible web AI proxy";
+            After = ["graphical-session.target"];
+          };
+          Service = {
+            ExecStart = lib.concatStringsSep " " (
+              [
+                "${cfg.package}/bin/web-model-bridge"
+                "--port"
+                (toString cfg.port)
+                "--host"
+                cfg.host
+                "--no-open"
+              ]
+              ++ lib.optionals (cfg.configFile != null) ["--config" (toString cfg.configFile)]
+              ++ cfg.extraArgs
+            );
+            Restart = "on-failure";
+            RestartSec = "5s";
+          };
+          Install.WantedBy = ["default.target"];
+        };
+      };
+    };
+  in
+    # ── per-system outputs (packages, devShells, …) ───────────────────────
+    flake-utils.lib.eachDefaultSystem (
+      system: let
+        pkgs = import nixpkgs {
+          inherit system;
+          overlays = [overlay];
+        };
+      in {
+        packages = {
+          web-model-bridge = pkgs.web-model-bridge;
+          default = pkgs.web-model-bridge;
+        };
+
+        devShells.default = pkgs.mkShell {
+          buildInputs = [pkgs.nodejs_22];
+          shellHook = ''
+            echo "web-model-bridge dev shell"
+            echo "Run: npm install && npm run build"
+          '';
+        };
+      }
+    )
+    # ── system-agnostic outputs ───────────────────────────────────────────
+    // {
+      # Conventional overlay output (consumers do: nixpkgs.overlays = [ inputs.web-model-bridge.overlays.default ])
+      overlays.default = overlay;
+
+      # home-manager modules (consumers do: imports = [ inputs.web-model-bridge.homeManagerModules.default ])
+      homeManagerModules.default = homeManagerModule;
+    };
+}