Files
pebrel/INSTALL.md
T

2.2 KiB

Installing Nebula

  1. Download NebulaTerminal-v0.4.0-windows-x64.zip from the Releases page.
  2. Unzip anywhere (no installer, no admin rights).
  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 release changes and installation details
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.

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).
  • Configuration lives at %APPDATA%\nebula\nebula.toml (created on demand); visual settings are in the in-app settings panel.