Skip to content

Installation

Use the standalone installer for your platform, Homebrew for package-managed updates, or the setup action in a GitHub Actions workflow.

curl -LsSf https://noodlerest.dev/install.sh | sh

Detects your OS and architecture, downloads the latest binary, and drops it at ~/.local/bin/noodle.

If ~/.local/bin isn’t on your $PATH, the script will let you know: just add this to your shell config (~/.zshrc, ~/.bashrc, etc.):

export PATH="$HOME/.local/bin:$PATH"

Custom install location? Set NOODLE_INSTALL_DIR:

curl -LsSf https://noodlerest.dev/install.sh | NOODLE_INSTALL_DIR=/usr/local/bin sh

Need a specific version? Pin it with NOODLE_VERSION:

curl -LsSf https://noodlerest.dev/install.sh | NOODLE_VERSION=v0.11.0 sh

Windows x64 binaries are included from v0.9.7. Run this in PowerShell 5.1 or later:

irm https://noodlerest.dev/install.ps1 | iex

The installer downloads noodle-windows-x86_64.exe, verifies its SHA-256 checksum, and installs it to %LOCALAPPDATA%\Programs\Noodle\noodle.exe. It adds that directory to your user PATH. Open a new terminal after installation.

Set $env:NOODLE_VERSION to pin a release, $env:NOODLE_INSTALL_DIR to choose another directory, or $env:NOODLE_SKIP_PATH_UPDATE = "1" to leave PATH alone. For example:

$env:NOODLE_VERSION = "v0.11.0"
irm https://noodlerest.dev/install.ps1 | iex

Windows ARM64 is unsupported. The executable is unsigned, so browser downloads may trigger Windows trust prompts. Ordinary-account interactive terminal testing remains pending. Manually dispatched CI runs provide a Windows beta ZIP with the executable, checksums, and build information for prerelease testing.

Windows x64 remains beta. Issue #279 reports Defender detecting Trojan:Win32/Ulthar.A!ml in v0.10.1; it remains unresolved and is not a confirmed false positive. As of November 8, 2026, v0.10.4 has passing Windows CI and release-artifact checks, but those checks do not establish current Defender acceptance or ordinary-user terminal behavior. See the Windows evidence and remaining limits.

brew install noodle

Noodle is available from Homebrew core. No additional tap is required. Upgrades stay under Homebrew’s control.

If you installed Noodle from wilfredinni/noodle, run:

brew update
brew reinstall noodle
brew untap wilfredinni/noodle

brew update transfers the installation to core. The one-time reinstall replaces the old tap binary with the official Homebrew build, including when both are v0.9.8. Run brew untap only after the reinstall succeeds. Your collections, configuration, and installed agent skills are preserved.

If you installed the managed agent skill, refresh it afterward:

noodle agent install

Use brew upgrade noodle for future updates. The old tap repository remains available to provide the migration mapping.

Install an exact CLI release for the next steps in your job:

- uses: noodle-rest/setup-noodle@v1
with:
version: v0.11.0
- run: noodle --version

@v1 selects the installer. Its required version input takes a stable Noodle release tag. The action downloads the runner’s binary, checks it against the release’s SHA256SUMS, and adds it to PATH. It supports macOS and Linux (glibc) on x64 and arm64, and Windows on x64. See the action repository or run a collection and upload its report.

Requires Bun.

git clone https://github.com/noodle-rest/noodle
cd noodle
bun install
bun run build:bin

The binary lands at ./noodle. On macOS, the build ad-hoc signs and verifies it before running the compiled scripting smoke check. Move it somewhere on your $PATH.

noodle --help

You should see the CLI usage output. To launch the TUI:

noodle

The CLI and its native file writer ship for these five targets.

Platform Architecture Binary
macOS arm64 ✅
macOS x86_64 ✅
Linux (glibc) x86_64 ✅
Linux (glibc) arm64 ✅
Windows x86_64 Beta, unsigned .exe

Both Apple Silicon and Intel Macs have prebuilt binaries. macOS release artifacts are ad-hoc signed and verified before publication, including checks of the downloaded artifact’s checksum, signature, version, and script sandbox.

noodle update

For Homebrew installations, noodle update prints Run: brew upgrade noodle without running it, including with --force. Run the upgrade yourself:

brew upgrade noodle

Then run noodle agent install if you have installed the managed agent skill. The TUI checks for available versions and shows the upgrade command in About and Updates, without installing a Homebrew update.

Standalone binaries read Noodle’s update manifest, download the matching release, and verify its SHA-256 checksum before replacement. Update checks cache release metadata for one hour; pass --force to bypass that cache, or --json for scripted use.

For standalone installations, the TUI performs the same check when it starts and installs an available update automatically. On Windows, the verified update is staged until Noodle exits; close and reopen it to apply the update. noodle update --json reports restart_required with log_path. If replacement fails, inspect that log, close all Noodle processes, and retry noodle update or rerun the PowerShell installer. Progress appears in the header and beside the current version in About and Updates, which is available from the command palette.

Install the noodle-use skill to teach your AI coding agent how to create, organize, and audit noodle collections:

noodle agent install

Noodle stores one managed copy under ~/.agents/skills/noodle-use, links detected Claude, Cursor, Codex, and OpenCode installations to it, and refreshes an existing managed installation after standalone updates. After a Homebrew upgrade, run noodle agent install explicitly. For other clients, use the skills CLI fallback:

npx skills add noodle-rest/noodle --skill noodle-use -g

After installing, ask your agent to scaffold a collection, audit your requests for security issues, or convert an Insomnia export.