Skip to content

INSTALL.md

Latest commit

 

History

History
135 lines (93 loc) · 2.57 KB

INSTALL.md

File metadata and controls

135 lines (93 loc) · 2.57 KB
Raw

Installing ULink CLI

npm (zero-install)

If you have Node.js, no installation is needed — run the CLI on demand via @ulinkly/cli:

npx @ulinkly/cli --version

Or install it globally:

npm install -g @ulinkly/cli

@ulinkly/cli downloads the matching native binary on first run and caches it under ~/.ulink/npm/. The npm version maps 1:1 to a CLI release (e.g. 1.2.0 → v1.2.0).

Quick Install (script)

macOS / Linux

curl -fsSL https://ulink.ly/install.sh | bash

Windows (PowerShell)

irm https://ulink.ly/install.ps1 | iex

The install script will:

  • Download the latest release for your platform
  • Install to ~/.ulink/bin
  • Add the binary to your PATH

Install Specific Version

macOS / Linux

curl -fsSL https://ulink.ly/install.sh | bash -s -- --version v1.0.0

Windows

& ([scriptblock]::Create((irm https://ulink.ly/install.ps1))) -Version v1.0.0

CI/CD Installation

For CI environments, use the --ci flag to skip interactive prompts:

curl -fsSL https://ulink.ly/install.sh | bash -s -- --ci

Manual Installation

Download from GitHub Releases

  1. Go to GitHub Releases
  2. Download the appropriate binary for your platform:
    • ulink-macos-arm64 - macOS Apple Silicon
    • ulink-macos-x64 - macOS Intel
    • ulink-linux-x64 - Linux x64
    • ulink-linux-arm64 - Linux ARM64
    • ulink-windows-x64.exe - Windows x64
  3. Make it executable (macOS/Linux): 
    chmod +x ulink-*
  4. Move to a directory in your PATH: 
    sudo mv ulink-* /usr/local/bin/ulink

For Dart Developers

If you have Dart SDK installed:

dart pub global activate --source git https://github.com/FlywheelStudio/ulink_cli.git

Verify Installation

After installation, verify it works:

ulink --version

You should see version information like:

ULink CLI Version: 1.0.0
Build Number: 37
Build Date: 2026-01-21

Updating

To update to the latest version, simply run the install script again:

# macOS / Linux
curl -fsSL https://ulink.ly/install.sh | bash

# Windows
irm https://ulink.ly/install.ps1 | iex

Uninstall

If installed via script

rm -rf ~/.ulink

Then remove the PATH entry from your shell config (~/.zshrc, ~/.bashrc, etc.).

If installed manually

sudo rm /usr/local/bin/ulink

If installed via Dart

dart pub global deactivate ulink_cli