CLI
The Ferret CLI is the primary tool for working with FQL scripts. Use it to execute queries, start an interactive shell, debug scripts, format source code, compile to bytecode, manage modules and browser instances, and configure persistent settings.
Start with the Overview to see how the commands fit together, or continue to Installation if the CLI is not installed yet.
Introduction
Overview
Understand the CLI workflow, commands, runtimes, and configuration.
Setup
Installation
Install, update, and verify the Ferret CLI.
Execution
Run
Execute FQL scripts from files, inline expressions, stdin, or compiled artifacts.
Interactive
REPL
Launch an interactive FQL shell for experimenting with queries.
Debugging
Debug
Debug FQL scripts interactively with breakpoints, stepping, and variable inspection.
Validation
Check
Verify FQL scripts for syntax and semantic errors without executing them.
Formatting
Fmt
Format FQL scripts to a consistent style.
Compilation
Build
Compile FQL scripts into bytecode artifacts for faster execution.
Introspection
Inspect
Disassemble compiled programs and examine bytecode, constants, and source spans.
Browser runtime
Browser
Start and stop managed browser instances for browser-backed scripts.
Modules
Mod
Discover, install, initialize, and publish Ferret modules.
Compatibility
Migrate
Check FQL compatibility and migrate supported Ferret v1 Go imports and final-FOR behavior to v2.
Configuration
Configuration
Manage persistent CLI settings for runtimes, browsers, and logging.