FdbShell 7.4.7

dotnet tool install --global FdbShell --version 7.4.7
                    
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 FdbShell --version 7.4.7
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=FdbShell&version=7.4.7
                    
nuke :add-package FdbShell --version 7.4.7
                    

FdbShell

A command-line shell for exploring and querying a live FoundationDB cluster.

Install

FdbShell is a .NET tool. Install it globally:

dotnet tool install --global FdbShell

Usage

fdbshell

It connects using the default cluster file (or one you point it at), and drops you into an interactive prompt. From there you can browse the Directory Layer, list and read keys and ranges, run queries, and inspect the cluster's status. A convenient way to poke at a cluster during development.

Connecting

By default fdbshell uses the standard FoundationDB cluster file. A few options make it easy to point it elsewhere, in particular at a cluster running locally in Docker:

  • -c, -C, --connfile <path>: path to a cluster file.
  • --connStr <string>: a connection string, instead of a file.
  • --docker <port>: connect to a local FoundationDB running in Docker on the given port.
  • --aspire [name]: connect to the FoundationDB resource of a .NET Aspire AppHost, using the connection string that Aspire injects into the environment (ConnectionStrings__<name>). The name is required only when the environment holds more than one FoundationDB connection string. Outside of an AppHost, --aspire stops with an error that lists the alternatives. It starts in the Root folder of the applications, unless --partition is specified.
  • --api <version>: the API version level to use.
  • --partition <name> (-p): open a named database partition.
  • --timeout <seconds> (-t), --retries <n> (-r): transaction defaults.
  • --exec "<command>": run a single command and exit (non-interactive).
fdbshell --docker 4550             # a cluster running in Docker on port 4550
fdbshell --aspire                  # the cluster of the Aspire AppHost that started fdbshell
fdbshell --exec "dir ls /"         # run one command and exit

Requires the native FoundationDB client (fdb_c / libfdb_c) matching your cluster's version.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
7.4.7 86 11/10/2026
7.4.2 294 7/13/2026
7.3.2 346 6/13/2025
7.3.0-preview2 278 10/18/2024