dofusdb 0.14.1-alpha.0.16

DofusDB CLI Tool

Overview

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

Using dotnet tool (recommended)

Download .NET 10, then install dofusdb:

dotnet tool install --global dofusdb

Using binaries

Download the latest release from the GitHub releases page.

Usage

Description:
  A command line interface for DofusDB.

Utilisation :
  dofusdb [command] [options]

Options :
  -?, -h, --help  Show help and usage information
  --version       Afficher les informations de version

Commandes :
  game-version         Get the version of the game corresponding to the data
  servers              Servers client
  characteristics      Characteristics client
  items                Items client
  item-images          Item images client
  item-types           Item Types client
  item-super-types     Item Super Types client
  item-sets            Item Sets client
  jobs                 Jobs client
  job-images           Job images client
  recipes              Recipes 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
  monsters             Monsters client
  monster-images       Monster images client
  monster-races        Monster Races client
  monster-super-races  Monster Super Races client
  worlds               Worlds client
  super-areas          Super Areas client
  areas                Areas client
  sub-areas            Sub Areas client
  maps                 Maps client
  map-images           Map images client
  map-positions        Map Positions client
  dungeons             Dungeons 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/]
  -?, -h, --help  Show help and usage information

Table data

Description:
  Items client

Utilisation :
  dofusdb items [command] [options]

Options :
  -?, -h, --help  Show help and usage information

Commandes :
  list         List all items
  get <id>     Get items by id
  build-query  Build the search query for items
  count        Count items

list

Description:
  List all items

Utilisation :
  dofusdb items list [options]

Options :
  --limit <limit>        Number of results to get. This might lead to multiple requests if the limit exceeds the API's maximum page size
  --skip <skip>          Number of results to skip
  --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 the console
  --pretty-print         Pretty print the JSON output
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -?, -h, --help         Show help and usage information

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 the console
  --pretty-print         Pretty print the JSON output
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -?, -h, --help         Show help and usage information

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"]
  --base <base>      Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -?, -h, --help     Show help and usage information

build-query

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

Description:
  Build the search query for items

Utilisation :
  dofusdb items build-query [options]

Options :
  --limit <limit>    Number of results to get. This might lead to multiple requests if the limit exceeds the API's maximum page size
  --skip <skip>      Number of results to skip
  --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"]
  --base <base>      Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -?, -h, --help     Show help and usage information

Image data

Description:
  Item images client

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

Options :
  -?, -h, --help  Show help and usage information

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, the output will be written to the console
  --base <base>          Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -?, -h, --help         Show help and usage information

Scalable image data

Description:
  Map images client

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

Options :
  -?, -h, --help  Show help and usage information

Commandes :
  get <id>  Get map images by i

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, the output will be written to the console
  --base <base>                              Base URL to use when building the query URL [default: https://api.dofusdb.fr/]
  -?, -h, --help                             Show help and usage information

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.