xrsh

Interactive text/OS terminal inside WebXR

Declared in: projects/xrsh/default.nix

1. Install Nix
   Debian

   Bash

   $ apt install --yes curl git jq nix

   Ubuntu

   Bash

   $ apt install --yes curl git jq nix

   Arch

   Bash

   $ pacman --sync --refresh --noconfirm curl git jq nix

2. Download a configuration file

   # default.nix
   {
     ngipkgs ? import (fetchTarball "https://github.com/ngi-nix/ngipkgs/tarball/main") { },
   }:
   ngipkgs.demo-shell (
     { ... }:
   
     {
       programs.xrsh.enable = true;
       programs.xrsh.port = 8090;
     }
   )
   

   Download
3. Enable binary substituters

   Bash

   $ export NIX_CONFIG='substituters = https://cache.nixos.org/ https://ngi.cachix.org/
   trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ngi.cachix.org-1:n+CAL72ROC3qQuLxIHpV+Tw5t42WhXmMhprAGkRSrOw='

4. Build and run the shell
   Debian Sid/Trixie

   Bash

   $ nix-build ./default.nix && ./result

   Ubuntu 25.04 and newer

   Bash

   $ nix-build ./default.nix && ./result

   Ubuntu 24.04/24.10

   Bash

   $ rev=$(nix-instantiate --eval --attr sources.nixpkgs.rev https://github.com/ngi-nix/ngipkgs/archive/master.tar.gz | jq --raw-output)

   $ nix-shell -I nixpkgs=https://github.com/NixOS/nixpkgs/archive/$rev.tar.gz --packages nix --run "nix-build ./default.nix && ./result"

   Arch

   Bash

   $ nix-build ./default.nix && ./result

5. Usage Instructions

   1. Run xrsh in the demo shell.

   2. Visit http://127.0.0.1:8090 on the browser to access the WebXR terminal.

   3. To change the web service port, set the environment variable XRSH_PORT before running the demo shell.

{ ... }:

{
  programs.xrsh.enable = true;
  programs.xrsh.port = 8090;
}

This project is funded by NLnet through these subgrants:

Entrust

xrsh

Related links:

• Install Manual
• xrsh forgejo repository