Installation

Choose how you will work with Ferret. Use Visual Studio Code for an editor-based workflow, the CLI for terminal and shell workflows, or embed the runtime when a Go or JavaScript application needs to execute FQL directly.

Alpha status

Ferret v2 is currently in alpha. The language, runtime, CLI, modules, and embedding APIs may change before beta. Pin versions for scripts, CI, and application integrations.

Looking for Ferret v1?

Ferret v1 remains available for existing projects, but new users should start with Ferret v2. See the v1 → v2 migration overview for automated changes and manual follow-up.

Use Visual Studio Code

Install the official Ferret Lang extension, published by ferretlang, then open or create a .fql file. Use the editor actions to run or debug the current file. The extension includes the matching Ferret daemon, so normal use does not require a separate ferretd installation or PATH configuration.

See Visual Studio Code for formatting, debugging, configuration, and troubleshooting.

Use the CLI

Choose the CLI to run FQL files and expressions from a terminal, shell script, or CI job.

$ferret version

See CLI Installation for prebuilt binaries, source installation, updates, and verification.

Embed Ferret in Go

Choose native Go embedding when the host needs full control over runtime configuration, modules, host values, codecs, and sandboxed services.

$go get github.com/MontFerret/ferret/v2@v2.0.0-alpha.55

Continue with Go Embedding: Getting Started.

Embed Ferret in JavaScript

Choose JavaScript embedding to run Ferret from Node.js or a modern browser through @montferret/ferret.

$npm install @montferret/ferret

Continue with JavaScript Embedding: Getting Started.

What to choose next

• Start with the Quick Start when you want to learn FQL in Visual Studio Code, the terminal, or the Playground.
• Read the Embedding overview when an application will own the runtime.
• Use Worker when an existing system needs Ferret through a separately deployed HTTP service.