Installation¶

Quick install¶

Linux / macOSWindows

curl -fsSL https://raw.githubusercontent.com/atbuy/noteui/main/install.sh | sh

This detects your OS and architecture, downloads the latest release, and installs both binaries to ~/.local/bin. If that directory is not on your PATH yet, the script will tell you how to add it.

Install a specific version:

curl -fsSL https://raw.githubusercontent.com/atbuy/noteui/main/install.sh | sh -s -- --version v0.9.1

Install to /usr/local/bin (system-wide, requires sudo):

curl -fsSL https://raw.githubusercontent.com/atbuy/noteui/main/install.sh | sh -s -- --system

Skip noteui-sync (not needed unless you use SSH sync):

curl -fsSL https://raw.githubusercontent.com/atbuy/noteui/main/install.sh | sh -s -- --no-sync

Run this in PowerShell:

irm https://raw.githubusercontent.com/atbuy/noteui/main/install.ps1 | iex

This installs both binaries to %LOCALAPPDATA%\noteui\bin and adds that directory to your user PATH.

Install a specific version (download the script first):

.\install.ps1 -Version v0.9.1

Skip noteui-sync:

.\install.ps1 -NoSync

Note

If you see an execution policy error, run Set-ExecutionPolicy RemoteSigned -Scope CurrentUser first.

The manual install and build-from-source options are documented below if you prefer them.

Release archive formats¶

Linux: .tar.gz
macOS: .tar.gz
Windows: .zip

Each release archive includes both noteui and noteui-sync. Most users only need to run noteui; noteui-sync is used when you configure SSH-based sync.

Tip

If you just want to use noteui, prefer release binaries over building from source.

Choosing an install method¶

Use release archives if you want the fastest and simplest install.

Use make install if you are building from a local checkout and want both binaries installed through Go tooling.

Use go run ./cmd/noteui mainly for development or quick local testing, not as a long-term install path.

Install from a release archive¶

LinuxmacOSWindows

Extract the release archive:

tar -xzf noteui-<version>-linux-amd64.tar.gz

Run the binaries:

chmod +x noteui-<version>-linux-amd64 noteui-sync-<version>-linux-amd64
./noteui-<version>-linux-amd64

Install them on your PATH:

mv noteui-<version>-linux-amd64 noteui
sudo mv noteui /usr/local/bin/
mv noteui-sync-<version>-linux-amd64 noteui-sync
sudo mv noteui-sync /usr/local/bin/

Extract the archive:

tar -xzf noteui-<version>-darwin-arm64.tar.gz

Run it:

chmod +x noteui-<version>-darwin-arm64 noteui-sync-<version>-darwin-arm64
./noteui-<version>-darwin-arm64

Install both binaries globally:

mv noteui-<version>-darwin-arm64 noteui
sudo mv noteui /usr/local/bin/
mv noteui-sync-<version>-darwin-arm64 noteui-sync
sudo mv noteui-sync /usr/local/bin/

Use darwin-arm64 on Apple Silicon and darwin-amd64 on Intel Macs.

Download the matching .zip archive and extract it using File Explorer or PowerShell.

PowerShell example:

Expand-Archive .\noteui-<version>-windows-amd64.zip -DestinationPath .\noteui

Run it:

.\noteui\noteui-<version>-windows-amd64.exe

If you want easier access, rename noteui-<version>-windows-amd64.exe to noteui.exe and place it in a directory on your PATH. If you plan to use sync, also place noteui-sync-<version>-windows-amd64.exe somewhere available for your remote sync setup.

Build from source¶

Note

Building from source is mainly useful for contributors or users who specifically want to build the binary themselves. Most users should prefer the release archives above.

If you prefer to build noteui yourself:

make build
./bin/noteui

Install both binaries from source:

make install

Or run directly from source without installing:

go run ./cmd/noteui

Verify the version¶

noteui --version

Next step¶

Continue with Getting started, Your first notes workflow, or the Sync guide if you want remote sync.