pebrel/INSTALL.md

Installing Nebula

Windows installer (recommended)

1. Download NebulaTerminal-<version>-windows-x64-setup.exe from the Releases page.
2. Follow the wizard to choose the installation directory and optional desktop or Windows sign-in shortcuts. The default per-user installation does not require administrator rights.
3. The installer installs the bundled Maple Mono font and can launch Nebula on the final page.

Uninstalling closes Nebula, runs nebula setup-ai --remove before deleting the program files, and removes Nebula's Claude, Codex, opencode, and Pi integration. Other user-owned hook and notifier entries are preserved.

Portable archive

1. Download NebulaTerminal-<version>-windows-x64.zip from the Releases page.
2. Unzip it anywhere.
3. Install the font: open fonts, double-click MapleMonoNormal-NF-CN-Regular.ttf, and press Install. Nebula embeds the same font as a runtime fallback, but the normal system installation remains recommended. Nebula checks at every launch and shows a dismissible reminder that can reopen the bundled fonts folder; restart Nebula after installing to load the complete icon set.
4. Run nebula.exe.

Keep the extracted directory structure intact:

Path	Purpose
nebula.exe	the terminal
README.md	overview and usage
runtime/nebula-hook.exe	AI turn-notification bridge (Claude Code / Codex)
runtime/conpty.dll + runtime/OpenConsole.exe	modern ConPTY host (correct resize, fast tab spawn)
fonts/MapleMonoNormal-NF-CN-Regular.ttf	Nerd Font for powerline/icons — install once (SIL OFL 1.1)
docs/CHANGELOG.md + docs/INSTALL.md + docs/lua-configuration.md	release changes, installation, and Lua configuration
licenses/	Nebula and third-party license notices

Build from source

Requirements: Windows 10 1809+ / 11, Rust 1.85+.

git clone https://github.com/Kuddev/nebula
cd nebula
cargo build --release

Build and assemble the portable archive with:

powershell -ExecutionPolicy Bypass -File scripts/package-release.ps1 `
  -Version unreleased -Force

The script builds the release workspace, verifies every required input, stages the directory layout above, creates the ZIP, and prints its file count, packed and unpacked sizes, and SHA-256. Use -SkipBuild only when the release binaries have already been built and verified.

Build the wizard-based installer with Inno Setup 6.7.3:

powershell -ExecutionPolicy Bypass -File scripts/build-installer.ps1 -Force

The installer build validates the same runtime inputs, pins and verifies the UTF-8 Simplified Chinese wizard translation, and prints the setup executable's size and SHA-256. Pass -InnoCompiler when ISCC.exe is installed in a custom directory.

First run

• Toast notifications register under the Nebula app identity automatically.
• Claude Code / Codex turn notifications are wired on first boot (nebula setup-ai --remove to undo; nebula notify-test to verify the toast pipeline).
• New configuration uses %APPDATA%\nebula\nebula.lua. Run nebula config init --language system to create an annotated template and nebula config check to validate it. Existing nebula.toml remains supported when no Lua configuration is present.
• Linux uses $XDG_CONFIG_HOME/nebula/nebula.lua (normally ~/.config/nebula/nebula.lua) and supports both Wayland and X11. The initial binary baseline is x86_64 glibc on Ubuntu 24.04, Debian 12, and Fedora 42.
• Visual settings remain available in the in-app settings panel.