dofusdb 0.18.0

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
This package has a SemVer 2.0.0 package version: 0.18.0+release.17748158134.1. 
dotnet tool install --global dofusdb --version 0.18.0
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 dofusdb --version 0.18.0
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=dofusdb&version=0.18.0
                    


                    

                
nuke :add-package dofusdb --version 0.18.0

DofusDB CLI Tool

Fetch data from the DofusDB API.

Overview

dofusdb is a command line interface (CLI) tool that exposes the API clients from the DofusSharp.DofusDb.ApiClients library. It allows users to interact with DofusDB resources and perform queries directly from the terminal.

Features

  • Query DofusDB items, recipes, runes, and other resources
  • Fetch item stats and details
  • Search and filter items by criteria

Installation

Download .NET 10, then install dofusdb:

dotnet tool install --global dofusdb

Using binaries

Download the latest release from the GitHub releases page.

Suggestions

Completions for the dofusdb CLI commands are powered by the underlying implementation using System.CommandLine. This enables intelligent tab completion for commands, options, and arguments in supported shells.

To enable tab completion for your shell, follow the official Microsoft documentation: How to enable tab completion for .NET CLI tools.

This will help you discover available commands and options more efficiently when using the CLI.

Usage

Types of clients:

  • Game version: get the current game version
  • Almanax: get the almanax data for a specific date
  • Criterion: parse a criterion string into a structured object
  • Table data: such as items, recipes, etc.
    • list: fetch rows of data from an API
    • get: fetch a single row of data by its unique identifier
    • count: get the total count of rows matching the specified filters
  • Image data: such as item-images, job-images etc.
    • get: fetch a single image by its unique identifier
  • Scalable image data: such as map-images etc.
    • get: fetch a single image by its unique identifier, with optional --scale flag
  • Breed image data: breed-images
    • symbol: fetch the breed symbol image
    • logo: fetch the breed logo image
    • head: fetch the breed head image

Usage:

Description:
  A command-line interface for querying the DofusDB API.
  Each subcommand targets a different resource type. Use the help option on a subcommand to see the available operations for that resource.
  Want to learn more? Visit us on GitHub: https://github.com/DofusSharp/DofusSharp/tree/main/dofusdb.

Utilisation :
  dofusdb [command] [options]

Options :
  -q, --quiet     Display less output
  -d, --debug     Show debugging output
  -?, -h, --help  Show help and usage information
  --version       Afficher les informations de version

Commandes :
  achievements            Achievements client
  achievement-images      Achievement images client
  achievement-categories  Achievement Categories client
  achievement-objectives  Achievement Objectives client
  achievement-rewards     Achievement Rewards client
  alignment-ranks         Alignment Ranks client
  alignment-sides         Alignment Sides client
  alliance-rights         Alliance Rights client
  almanax <date>          Get the almanax of the given day [default: 15/09/2025]
  almanax-calendars       AlmanaxCalendars client
  alterations             Alterations client
  areas                   Areas client
  breeds                  Breeds client
  breed-images            Breed images client
  challenges              Challenges client
  challenge-images        Challenge images client
  characteristics         Characteristics client
  criterion <criterion>   Parse a criterion string into a JSON array with more information
  dungeons                Dungeons client
  game-version            Get the version of the game corresponding to the data
  guild-rights            Guild Rights client
  items                   Items client
  item-images             Item images client
  item-sets               Item Sets client
  item-super-types        Item Super Types client
  item-types              Item Types client
  jobs                    Jobs client
  job-images              Job images client
  maps                    Maps client
  map-images              Map images client
  map-positions           Map Positions client
  monsters                Monsters client
  monster-images          Monster images client
  monster-races           Monster Races client
  monster-super-races     Monster Super Races client
  mounts                  Mounts client
  mount-behaviors         MountBehaviors client
  mount-families          Mount Families client
  npcs                    NPCs client
  npc-messages            NPC Messages client
  ornaments               Ornaments client
  ornament-images         Ornament images client
  recipes                 Recipes client
  servers                 Servers client
  skills                  Skills client
  spells                  Spells client
  spell-images            Spell images client
  spell-levels            Spell Levels client
  spell-states            Spell States client
  spell-state-images      Spell State images client
  spell-variants          Spell Variants client
  sub-areas               Sub Areas client
  super-areas             Super Areas client
  worlds                  Worlds client

Game version

Description:
  Get the version of the game corresponding to the data

Utilisation :
  dofusdb game-version [options]

Options :
  --base <base>   Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run   Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help  Show help and usage information
  -q, --quiet     Display less output
  -d, --debug     Show debugging output

Almanax

Description:
  Get the almanax of the given day

Utilisation :
  dofusdb almanax [<date>] [options]

Arguments :
  <date>  The specific day for which to retrieve the Almanax calendar data (format: MM/DD/YYYY) [default: 15/09/2025]

Options :
  -o, --output <output>  File to write the JSON output to. If not specified, the output will be written to stdout
  --pretty-print         Pretty print the JSON output
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run          Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help         Show help and usage information
  -q, --quiet            Display less output
  -d, --debug            Show debugging output

Criterion

Description:
  Parse a criterion string into a JSON array with more information

Utilisation :
  dofusdb criterion <criterion> [options]

Arguments :
  <criterion>  Criterion to parse

Options :
  --lang <En|Fr>         Language to request
  -o, --output <output>  File to write the JSON output to. If not specified, the output will be written to stdout
  --pretty-print         Pretty print the JSON output
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run          Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help         Show help and usage information
  -q, --quiet            Display less output
  -d, --debug            Show debugging output

Table data

Description:
  Items client

Utilisation :
  dofusdb items [command] [options]

Options :
  -?, -h, --help  Show help and usage information
  -q, --quiet     Display less output
  -d, --debug     Show debugging output

Commandes :
  list      List all items
  get <id>  Get items by id
  count     Count items
list
Description:
  List all items

Utilisation :
  dofusdb items list [options]

Options :
  -a, --all              Fetch all available results, ignoring --limit. The --skip option is still honored when this option is set
  --limit <limit>        Maximum number of results to retrieve. If the value exceeds the API’s maximum page size, multiple requests will be performed [default: 10]
  --skip <skip>          Number of results to skip [default: 0]
  --select <select>      Comma separated list of fields to include in the results. If not specified, all fields are included [example: --select "id,name.fr,level"]
  --sort <sort>          Comma separated list of fields to sorts the results by. Prefix with '-' for descending order [example: --sort "-level,name.fr"]
  --filter <filter>      Comma separated list of predicates to filter the results by. Each predicate is made of the name of the field, an operator (=, !=, <, <=, >, >=) and the value. Multiple values can be separated by '|' for '=' operator (in) and for '!=' operator (not in) to match any of the values 
                         [example: --filter "level>=10,name.fr=Razielle|Goultard"]
  -o, --output <output>  File to write the JSON output to. If not specified, the output will be written to stdout
  --pretty-print         Pretty print the JSON output
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run          Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help         Show help and usage information
  -q, --quiet            Display less output
  -d, --debug            Show debugging output
Pagination

Results can be paginated using the --limit and --skip options.

    dofusdb items list --limit 50 --skip 100
Column selection

Results can be limited to specific fields using the --select option.

    dofusdb items list --select id,name,level
Sorting

Results can be sorted by one or more fields using the --sort option. Prefix a field with - for descending order.

    dofusdb items list --sort level,-name
Filtering

Results can be filtered using the --filter option. Each predicate is made of the name of the field, an operator (=, !=, <, <=, >, >=) and the value.

    dofusdb items list --filter "level>=10,name=Excalibur"

Additionally, equality and inequality operators accept multiple values separated by |, which transform them into IN and Not IN operators.

get

Fetch a single resource by its unique identifier.

Description:
  Get items by id

Utilisation :
  dofusdb items get <id> [options]

Arguments :
  <id>  Unique identifier of the resource

Options :
  -o, --output <output>  File to write the JSON output to. If not specified, the output will be written to stdout
  --pretty-print         Pretty print the JSON output
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run          Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help         Show help and usage information
  -q, --quiet            Display less output
  -d, --debug            Show debugging output
count

Get the total count of resources that would be returned by the list command with the same filters applied.

Description:
  Count items

Utilisation :
  dofusdb items count [options]

Options :
  --filter <filter>      Comma separated list of predicates to filter the results by. Each predicate is made of the name of the field, an operator (=, !=, <, <=, >, >=) and the value. Multiple values can be separated by '|' for '=' operator (in) and for '!=' operator (not in) to match any of the values 
                         [example: --filter "level>=10,name.fr=Razielle|Goultard"]
  -o, --output <output>  File to write the JSON output to. If not specified, the output will be written to stdout
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run          Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help         Show help and usage information
  -q, --quiet            Display less output
  -d, --debug            Show debugging output
build-query

Build the search query URL for the specified parameters without executing the request.

Description:
  Items client

Utilisation :
  dofusdb items [command] [options]

Options :
  -?, -h, --help  Show help and usage information
  -q, --quiet     Display less output
  -d, --debug     Show debugging output

Commandes :
  list      List all items
  get <id>  Get items by id
  count     Count items

Image data

Description:
  Item images client

Utilisation :
  dofusdb item-images [command] [options]

Options :
  -?, -h, --help  Show help and usage information
  -q, --quiet     Display less output
  -d, --debug     Show debugging output

Commandes :
  get <id>  Get item images by id
get
Description:
  Get item images by id

Utilisation :
  dofusdb item-images get <id> [options]

Arguments :
  <id>  Unique identifier of the resource

Options :
  -o, --output <output>  File to write the JSON output to. If not specified, an arbitrary file name will be used
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run          Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help         Show help and usage information
  -q, --quiet            Display less output
  -d, --debug            Show debugging output

Scalable image data

Description:
  Map images client

Utilisation :
  dofusdb map-images [command] [options]

Options :
  -?, -h, --help  Show help and usage information
  -q, --quiet     Display less output
  -d, --debug     Show debugging output

Commandes :
  get <id>  Get map images by id

get

Description:
  Get map images by id

Utilisation :
  dofusdb map-images get <id> [options]

Arguments :
  <id>  Unique identifier of the resource

Options :
  --scale <Full|Half|Quarter|ThreeQuarters>  Scale of the image to fetch [default: Full]
  -o, --output <output>                      File to write the JSON output to. If not specified, an arbitrary file name will be used
  --base <base>                              Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run                              Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help                             Show help and usage information
  -q, --quiet                                Display less output
  -d, --debug                                Show debugging output

Breed image data

Description:
  Breed images client

Utilisation :
  dofusdb breed-images [command] [options]

Options :
  -?, -h, --help  Show help and usage information
  -q, --quiet     Display less output
  -d, --debug     Show debugging output

Commandes :
  symbol <symbol-id>  Retrieve the symbol image for a breed using its ID
  logo <logo-id>      Retrieve the logo image for a breed using its ID
  head <head-id>      Retrieve the head image for a breed using its ID

symbol

Description:
  Retrieve the symbol image for a breed using its ID

Utilisation :
  dofusdb breed-images symbol <symbol-id> [options]

Arguments :
  <symbol-id>  The unique identifier of the breed symbol to retrieve. Symbol ID = Breed ID)

Options :
  -o, --output <output>  File to write the JSON output to. If not specified, an arbitrary file name will be used
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run          Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help         Show help and usage information
  -q, --quiet            Display less output
  -d, --debug            Show debugging output

Description:
  Retrieve the logo image for a breed using its ID

Utilisation :
  dofusdb breed-images logo <logo-id> [options]

Arguments :
  <logo-id>  The unique identifier of the breed logo to retrieve. Logo ID = Breed ID

Options :
  -o, --output <output>  File to write the JSON output to. If not specified, an arbitrary file name will be used
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run          Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help         Show help and usage information
  -q, --quiet            Display less output
  -d, --debug            Show debugging output

Description:
  Retrieve the head image for a breed using its ID

Utilisation :
  dofusdb breed-images head <head-id> [options]

Arguments :
  <head-id>  The unique identifier of the breed head to retrieve. Male head ID = breed ID × 10, female head ID = breed ID × 10 + 1

Options :
  -o, --output <output>  File to write the JSON output to. If not specified, an arbitrary file name will be used
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -n, --dry-run          Do not perform the HTTP queries, display the request URL instead
  -?, -h, --help         Show help and usage information
  -q, --quiet            Display less output
  -d, --debug            Show debugging output

Contributing

Contributions are welcome! Please open issues or submit pull requests for bug fixes, features, or documentation improvements.

License

This project is licensed under the terms of the MIT License.

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.18.0 31 9/15/2025
0.17.0 28 9/14/2025
0.16.0 31 9/14/2025
0.15.1 37 9/13/2025
0.14.1-alpha.0.17 26 9/13/2025
0.14.1-alpha.0.16 24 9/13/2025
0.14.1-alpha.0.14 26 9/13/2025
0.14.0 31 9/11/2025