Skip to content

JSON

A JSON file is a way of storing and sharing data in a structured format that's easy for computers to read and understand. It's kind of like a digital version of a spreadsheet or a database, but it's designed to be more lightweight and flexible.

JSON parameters

Required parameters are in red and Optional parameters are in blue.


  • directory, the folder location to write JSON files to

  • encoding, whether or not to accept double-byte characters, like japanese or cryillic
    default: None ( allowed: UTF-8 )

  • indentation, the number of spaces to indent when writing to a file, used for pretty-printing data
    default: None ( no pretty-printing will be formatted)
How do I use the JSON syncer in commands?

cs_tools tools searchable bi-server --syncer json://directory=.

- or -

cs_tools tools searchable bi-server --syncer json://definition.toml

Definition TOML Example

definition.toml

[configuration]
directory = '...'