Skip to content

README.md

Latest commit

 

History

History
119 lines (78 loc) · 2.36 KB

README.md

File metadata and controls

119 lines (78 loc) · 2.36 KB

Ferret Compiler

This folder contains the Ferret compiler, installer scripts, and local build scripts.

Install from GitHub Releases

The install scripts download the latest Ferret release from Ferret-Language/Ferret, extract the compiler bundle and toolchain, and add ferret to your PATH.

Supported release installers:

  • Linux: amd64, arm64
  • macOS: amd64, arm64
  • Windows: amd64, arm64

Linux

curl -fsSL https://raw.githubusercontent.com/Ferret-Language/Ferret/refs/heads/main/install-ferret.sh | bash

If you prefer wget:

wget -qO- https://raw.githubusercontent.com/Ferret-Language/Ferret/refs/heads/main/install-ferret.sh | bash

Install a specific release tag:

curl -fsSL https://raw.githubusercontent.com/Ferret-Language/Ferret/refs/heads/main/install-ferret.sh | bash -s -- v0.1.0

Default install location:

~/.local/ferret

macOS

Use the same installer script:

curl -fsSL https://raw.githubusercontent.com/Ferret-Language/Ferret/refs/heads/main/install-ferret.sh | bash

Install a specific release tag:

curl -fsSL https://raw.githubusercontent.com/Ferret-Language/Ferret/refs/heads/main/install-ferret.sh | bash -s -- v0.1.0

Default install location:

~/.local/ferret

Windows PowerShell

Invoke-WebRequest https://raw.githubusercontent.com/Ferret-Language/Ferret/refs/heads/main/install-ferret.ps1 -OutFile install-ferret.ps1
powershell -NoProfile -ExecutionPolicy Bypass -File .\install-ferret.ps1

Install a specific release tag:

Invoke-WebRequest https://raw.githubusercontent.com/Ferret-Language/Ferret/refs/heads/main/install-ferret.ps1 -OutFile install-ferret.ps1
powershell -NoProfile -ExecutionPolicy Bypass -File .\install-ferret.ps1 -Version v0.1.0

Windows CMD

Download and run the wrapper script:

curl -fsSLO https://raw.githubusercontent.com/Ferret-Language/Ferret/refs/heads/main/install-ferret.cmd
install-ferret.cmd

Default install location:

%LOCALAPPDATA%\Ferret

Verify the installation

Open a new terminal and run:

ferret --help

Build from source

Prerequisite:

  • Go must be installed and available in PATH.

Linux and macOS

./build.sh

Windows

build.bat

The packaged output is written under:

build/core
build/toolchain