Scribe-Data provides a command-line interface (CLI) for efficient interaction with its language data functionality.
To utilize the Scribe-Data CLI, you can execute the following command in your terminal:
scribe-data [command] [options]
list
(l
): Enumerate available languages, data types and their combinations.query
(q
): Retrieve data from Wikidata for specified languages and data types.total
(t
): Display the total available data for given languages and data types.convert
(c
): Transform data returned by Scribe-Data into different file formats.
-
Display all available options:
scribe-data list
-
Display available languages:
scribe-data list -lang # --language
-
Display available data types:
scribe-data list -dt # --data-type
-
Display total available data for a specific data type (e.g. nouns):
scribe-data total -dt nouns
-
Display total available data for a specific language (e.g. English):
scribe-data total -l English
-
Display total available data for both language and data type (e.g. English nouns):
scribe-data total -l English -dt nouns
-
Query all available languages and data types:
scribe-data query -a # --all
-
Query specific language and data type (e.g. German nouns):
scribe-data query -lang German -dt nouns
-
Retrieve data for both language and data type (e.g. English nouns) in CSV format:
scribe-data query -l english --data-type verbs --output-dir ./output_data --output-type csv
-
Retrieve data for both language and data type (e.g. English nouns) in TSV format:
scribe-data query -l english --data-type verbs --output-dir ./output_data --output-type tsv
The CLI also offers an interactive query mode, which can be initiated with the following command:
scribe-data query -i
This mode guides users through the data retrieval process with a series of prompts:
- Language selection: Users can choose from a list of available languages or select all.
- Data type selection: Users can specify which types of data to query.
- Output configuration: Users can set the file format, export directory, and overwrite preferences.
The interactive mode is particularly useful for users who prefer a guided approach or are exploring the available data options.
For more detailed information on each command and its options, append the --help
flag:
scribe-data --help # -h
scribe-data [command] --help
For comprehensive usage instructions and examples, please refer to the official documentation.