FsHotWatch.Cli 0.8.0-alpha.12

This is a prerelease version of FsHotWatch.Cli.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet tool install --global FsHotWatch.Cli --version 0.8.0-alpha.12
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local FsHotWatch.Cli --version 0.8.0-alpha.12
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=FsHotWatch.Cli&version=0.8.0-alpha.12&prerelease
                    
nuke :add-package FsHotWatch.Cli --version 0.8.0-alpha.12
                    

FsHotWatch.Cli

Command-line tool for the FsHotWatch daemon. It auto-starts the daemon in the background when you run any command, so you don't need to manually manage daemon lifecycle.

Install

dotnet tool install -g FsHotWatch.Cli

Quick start

# Run all checks (scan, build, lint, errors)
fshw check

# Start daemon in foreground (useful for debugging)
fshw start

# Check plugin statuses
fshw status

Commands

Command Description
start Start daemon in foreground (auto-scans on boot, Ctrl+C to stop).
stop Gracefully stop the running daemon.
scan Re-scan all files.
scan-status Check scan progress without blocking.
status [plugin] Show plugin statuses. Optionally filter to one plugin.
build Trigger a build and wait for completion.
test [opts] Run tests. Options: -p project, -f filter, --only-failed.
format Run Fantomas formatter on all files.
lint Run FSharpLint on all files and report warnings.
errors Show current errors from all plugins.
check Full check: scan all files, wait for plugins, then report errors.
config check Validate .fshw.json without starting the daemon. Exits 0 on valid config, 2 on parse/validation error.
invalidate-cache <file> Clear cache for a file and re-check it.
<command> [args] Run any plugin-registered command (e.g. diagnostics).

Options

Flag Description
-v, --verbose Show per-file status transitions (same as --log-level=debug).
--log-level=<level> Set log level: error, warning, info, debug (default: info).
--no-cache Disable the check result cache.

Examples

# Run tests for a specific project
fshw test -p MyApp.Tests

# Run only previously-failed tests
fshw test --only-failed

# Show just the lint plugin's status
fshw status lint

# Query a plugin command directly
fshw diagnostics
fshw coverage
fshw warnings

Config validation

.fshw.json is parsed strictly: any parse or validation error aborts startup with exit code 2 and a message naming the offending field. Use fshw config check to validate without starting the daemon (handy for editor integration and CI).

While the daemon is running, any write to .fshw.json causes it to stop cleanly, logging the reason:

  • Valid edit: config changed, stopping (restart to apply)
  • Invalid edit: config invalid, stopping: <parse error>

Re-invoke the CLI to start a fresh daemon with the new config. There is no hot-reload — symmetric stop-on-any-change avoids the race risks of mid-flight plugin re-registration.

How it works

The CLI computes a deterministic pipe name from your repo root, then communicates with the daemon over named pipes (StreamJsonRpc). If the daemon isn't running or its config has changed, the CLI automatically starts/restarts it in the background.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
0.8.0-alpha.16 0 6/2/2026
0.8.0-alpha.15 48 5/28/2026
0.8.0-alpha.14 65 5/26/2026
0.8.0-alpha.13 78 5/4/2026
0.8.0-alpha.12 64 4/29/2026
0.8.0-alpha.11 63 4/26/2026
0.8.0-alpha.10 68 4/25/2026
0.8.0-alpha.9 74 4/23/2026
0.8.0-alpha.8 83 4/22/2026
0.8.0-alpha.7 59 4/20/2026
0.8.0-alpha.6 61 4/20/2026
0.8.0-alpha.3 66 4/18/2026
0.8.0-alpha.2 75 4/15/2026
0.6.0-alpha.1 77 4/12/2026
0.5.0-alpha.1 62 4/12/2026
0.3.0-alpha.1 68 4/8/2026
0.1.0-alpha.1 74 4/3/2026