Console Commands

This a list of the Cardbuilder commands which can be invoked from the terminal to generate flashcards and manage Cardbuilder settings. No coding necessary.

Utility Commands

cardbuilder.scripts.tools.help_cmd()[source]

Provides a list of possible Cardbuilder commands, or information about a specific command.

Used like cardbuilder help or cardbuilder help <command>

Return type

None

cardbuilder.scripts.tools.purge_all_data()[source]

Delete’s Cardbuilder’s local database, along with any downloaded content. This command exists mostly for debugging purposes; if you do this, Cardbuilder will need to redownload data next time it runs.

Used like cardbuilder purge_all

Return type

None

cardbuilder.scripts.tools.purge_config()[source]

Clears Cardbuilder’s local config.

Used like cardbuilder purge_conf

Return type

None

cardbuilder.scripts.tools.purge_database()[source]

Deletes Cardbuilder’s local database, clearing the config and any cached content.

Used like cardbuilder purge_db

Return type

None

cardbuilder.scripts.tools.set_conf()[source]

Sets the specified value in Cardbuilder’s configuration.

Used like cardbuilder set_conf <key> <value>

Return type

None

cardbuilder.scripts.tools.view_conf()[source]

Prints Cardbuilder’s current configuration from the database.

Used like cardbuilder view_conf

Return type

None