Home /Modules/install/README.md

README.md

install/README.md · 319 line(s) · markdown

<img align="right" src="https://github.com/mearvk/SLeeLa/blob/master/images/debian/debian-logo.png" width="75" height="75" alt="SLeeLa">

SLeeLa Quick and Safe Install

The installer supports user-local and system-wide installation on Linux, macOS, and Windows 10+. User-local installation is the recommended default and does not require administrator access.

For a calm, beautiful, guided install of the main package only, run:

make clean-install          # auto-selects the host platform; or run directly:
./install/sleela-clean-install.sh         # Linux
bash ./install/sleela-clean-install-macos.sh   # macOS (bash 3.2-safe)
install\\sleela-clean-install.cmd               # Windows 10+ (PowerShell launcher)

make clean-install and the make build → advanced-build prompt dispatch by host OS. The macOS script is Bash 3.2-compatible. Windows uses native PowerShell and requires native MinGW-w64 toolchain and Python 3. The PowerShell installer invokes build-windows.ps1 for a native build; with -NoBuild, it requires the existing impl/build/sleela.exe, sleelvac.exe, and nordshrift.exe artifacts and will not relabel non-Windows binaries as .exe. All three scripts share the same guided, block-by-block module selection and verify the staged integrity manifest before deployment.

It installs the binaries (sleela, sleelvac, nordshrift), the standard library, protocols, and support modules — and excludes servers, IDEs/editors, Wi-Fi implementations, and religious/moral/political systems. You make one primary decision (install the main package), choose a scope, and then — on success — may optionally add curated enhancement modules (audio, video, signal-processing, codecs, compression, gui, ui, database, connector).

After the four module blocks, the installer offers a fifth block of top-level programs — stand-alone subsystems that live as their own top-level directories rather than lib/ packages, so they are selected and staged explicitly:

The block defaults to yes (include all); decline it to choose each program individually, or they are all pulled in by the "install EVERYTHING" fast path.

After the module blocks, the installer also offers the SleelaTerminal — the original GUI terminal and slsh shell (a separate C++ component under sleela-terminal/, not a lib/ package). Answer yes and it is built and copied into the same scope you chose: for a user-local install into your user directory ($INSTALL_ROOT/bin, with its assets/), or for a system install into the system directories under /usr/local (binaries in /usr/local/bin, assets in /usr/local/bin/assets, and a .desktop entry). The GUI needs GTK4 + VTE development packages (gtk4 and vte-2.91-gtk4); when they are not present the installer still installs the slsh shell and skips the GUI binary with a clear note, so the choice always yields a usable terminal. Declining leaves the main package untouched. (On Windows, the .cmd/PowerShell installer does not build this Unix GUI component.)

The output is styled with the SLeeLa palette and degrades to plain text automatically when not attached to a terminal, when NO_COLOR is set, or with --plain. The full-featured installer below (with server/HTTP/VM-edition options) remains available for advanced deployments.

Installation scope

At the start, choose:

The Linux/macOS user-local destination can be overridden with SLEELA_INSTALL_ROOT; system runtime root can be overridden with SLEELA_SYSTEM_ROOT. On Windows, pass -Destination to choose the destination explicitly.

Installation flow

  1. Choose user-local or system-wide scope.
  2. Select SLeeLa System/server, HTTP servers 1–9, VM edition, and Port Authority startup options.
  3. Build SLeeLa before deployment unless the Windows -NoBuild option is used.
  4. Stage the runtime, including the compiled sleela, sleelvac, and nordshrift products.
  5. Back up an existing destination before updating it.
  6. Install binaries, libraries, and config/startup.conf.
  7. Configure only the PATH scope corresponding to the selected installation mode.
  8. Report the installation and configuration locations.

A missing compiled product or failed build stops installation before deployment.

Platform entry points

Native Drive installation

The runtime staging steps include the Native Drive helpers tools/sleela-native-drive.py and tools/sleela-native-service.py alongside the SLeeLa control plane. Both scripts are included in the trusted SHA-256 manifest and are copied into the installed runtime's tools/ directory by the conventional, POSIX quick-safe, and Windows quick-safe installers. Python 3 is required to invoke Native Drive through sleelactl.

After installation, use sleelactl info native-drive to confirm the registered tool and sleelactl inspect native-drive service --help for the service generator's options. Service installation, enabling, and starting remain explicit operator actions.

Safety model

Commands

make install-help
make install-check
make install-local                      # user-local, never uses sudo
make install-system                     # system-wide, uses sudo (system paths only)
./install/system-install.sh             # the sudo system installer directly
./install/quick-safe-install.sh
./install/quick-safe-install-macos.sh
install\\quick-safe-install.cmd

User-local vs system-wide, and sudo

The two scopes are deliberately separated so a user-local install never has any reason to elevate:

Base-code integrity prompt on every install

Before any install variant copies files, it offers to (re)generate and verify the base SLeeLa code SHA-256 manifest — the integrity baseline the runtime's execution gate checks against — as a plain yes/no prompt:

Answer non-interactively (CI, package builds) with SLEELA_MANIFEST_CONSENT=yes|no|skip. When no terminal is attached and the variable is unset, the step is skipped safely.

How installed commands find their libraries (standard resolution)

You are expected to run the installed sleela/sleelvac, not the copy in a git checkout. An installed command finds its support files from the install location, derived from the command's own path, so it works from any working directory and without setting environment variables:

Resolution order for each resource (first match wins):

  1. the matching environment variable, if set — SLEELA_LIB (library tree), SLEELA_SHEET (catalog), SLEELA_HOME / SLEELA_SHA256_MANIFEST (verify gate) — these remain available as explicit overrides;
  2. the installed runtime root derived from the executable's own location (<prefix>/bin → <prefix>/lib/sleela);
  3. the SLeeLa root found by searching upward from the current directory — this is what lets a developer run the build-tree binary from inside the checkout.

So after make install / make install-system, running sleela run foo.sleela from anywhere resolves /lib, the manifest, and the catalog from <prefix>/lib/sleela — not from the clone, and not from the current directory. The clone is only used when you run the uninstalled build-tree binary.

Reinstall safety: existing files are backed up, not clobbered

A reinstall over an existing install first snapshots the previous binaries and the runtime/data trees into a timestamped directory beside the runtime tree (<prefix>/lib/sleela-backups/<YYYYmmdd-HHMMSS>/) before writing the new files. Old files are retained there and never removed automatically — delete a snapshot yourself when you no longer need the rollback. The install tracker does not record the backups, so make uninstall leaves them in place. (Override the location with BACKUP_ROOT=...; staged DESTDIR package builds skip the backup because they target a fresh package root, not a live system.) The installer also still refuses to overwrite same-named commands that are not tracked as a SLeeLa install.

What sudo does and does not touch

When make install-system (or a system-scoped make install) elevates, sudo is used only to copy SLeeLa into system locations as the trusted system account. The install:

A confirming privilege note is printed at the end of a system install.

SLeeLa — MEARVK LLC — 2026

Conventional make install

The conventional installation target is non-interactive and installs the built native commands (sleela, sleelvac, and nordshrift) plus runtime libraries, verification tooling, documentation, examples, and a default configuration. It does not replace the interactive Quick and Safe installer above.

From the repository root:

make -C impl all
make install-local                        # user-local; NEVER uses sudo (defaults PREFIX=$HOME/.local)
make install-system                       # system-wide; uses sudo for system paths only
make install                              # scope-aware: local prefix stays local, system prefix elevates
make install PREFIX="$HOME/.local"         # user-local; stays as current user
make install DESTDIR="$PWD/package-root"  # staged package installation
make install SLEELA_MANIFEST_CONSENT=no   # answer the SHA-256 manifest prompt non-interactively
make install-check                        # verify installer entry points
make uninstall                            # remove tracked executables/runtime; preserve config
make uninstall PREFIX="$HOME/.local"       # remove a tracked user-local install
make -C install uninstall                  # lower-level equivalent

Privilege handling is scope-aware and split into two explicit targets so the user-local path never elevates:

Every variant first offers the base-code SHA-256 manifest step (yes/no); SLEELA_MANIFEST_CONSENT=yes|no|skip answers it without a terminal. When a system install elevates, sudo only copies new files into the system prefix as the trusted system account — it never re-owns or alters files you already own, and never touches your home directory. Avoid running sudo make install with a user-home prefix; use make install-local as the target user instead.

The default executable directory is $(PREFIX)/bin, runtime support files are under $(PREFIX)/lib/sleela, and shared documentation/examples are under $(PREFIX)/share/sleela. The default configuration is /etc/sleela/startup.conf for the default /usr/local prefix. For a custom prefix, configuration defaults to $HOME/.config/sleela/startup.conf, so a user-local install does not need root privileges. An existing configuration is never overwritten. Use BINDIR, LIBDIR, DATADIR, and SYSCONFDIR to override the corresponding destinations. On Linux, /usr/local/bin is preferred to /usr/bin for a source installation so system package-manager files are not overwritten. The uninstall target removes the three tracked executables (sleela, sleelvac, and nordshrift) and the tracked runtime/shared-data files for the selected prefix. It preserves configuration and refuses to remove untracked same-named binaries. Use the same PREFIX, BINDIR, LIBDIR, DATADIR, SYSCONFDIR, and DESTDIR values used during installation.


SLeeLa

<p align="center"><img src="images/sleela/sleela-wordmark.svg" alt="SLeeLa — The Now. The Ingredient." width="560"></p> <p align="center"><img src="https://github.com/mearvk/SLeeLa/blob/master/images/sleela-programming-language-002.jpg" alt="SLeeLa Marketing Logo" width="560"></p>