Listiary Spark v0.5
Spark 0.5 is a rewrite of Spark 0.4 in a Cli tool and Library format.
Now, we have one tool that is the Cli runner - SparkCli, and the library that can be reused across other projects - SparkLib.
Spark is an administrative CLI interface for administering the Listiary database layer. Spark is very powerful and unforgiving - be careful which script you are invoking and read the documentation.
Spark is licensed under GNU Affero General Public License, version 3 (AGPLv3).
For more information visit documentation.listiary.org/listiary/wiki/spark/.
List of articles
Spark 0.5 - Misc - The help command and more.
Spark 0.5 - Presentation flags - The presentation flags for functions.
Spark 0.5 - Configs - How SparkCli deals with Listiary configs.
Spark 0.5 - REPL - REPL and no-repl functions in SparkCli 0.5.
Spark 0.5 - Files and Jsons - Raw Describe file operations on the database.
Spark 0.5 - Metadata - Metadata operations on the database.
Spark 0.5 - Database and Action - Functions that deal with the database as a whole.
List of commands
NONE - This is running the SparkCli without any arguments. Will output the help message.
UNKNOWN - This is running the SparkCli with some invalid first argument. Will output the help message.
PRESENTATION_FLAGS - Presentation flags for the functions.
help - Output the help message.
config-make - Make a config file, by asking the user to input values on the CMD.
config-make-online - Make a config file. Test connection and credentials.
config-make-offline - Make a config file. Don’t test connection and credentials.
configs-list - List all the configs in the _configs folder.
config-show - Show the constants inside the selected config.
config-test - Test the selected config against the backend server.
config-test-compiler - Test the compiler service for the current config.
action-create-stub - Create a new article stub.
action-delete-article - Delete an article and all its files.
database-test - Test if database is working and empty for Listiary installation.
database-make-tables - Make the tables in an empty database, installing a wiki instance.
database-wipe - Nuke a database, deleting everything from it.
database-download - Download a copy of the database.
database-upload - Upload a copy of the database.
database-recompile - Recompile all the files in the database.
database-curate - Generate the full metadata for all the files.
database-curate-ids - Generate the metadata for all the files, populating 1 of the 2 tables.
database-curate-filenames - Generate the metadata for all the files, populating 1 of the 2 tables.
database-find-orphans - Find orphaned articles in the database.
file-view - Output the contents of a single file.
file-download - Download a Describe file.
file-upload - Upload a Describe file to the database.
file-compile - Compile a single file in the database to JSON.
file-delete - Delete a single file.
files-list - List the files in the database.
files-count - Count the files in the database.
files-download - Download Describe files from the database.
files-upload - Upload Describe files to the database.
files-compile - Compile all Describe files in the database, populating the JSONs table.
files-delete - Delete all the Describe files from the database.
json-view - Output the contents of a single json file.
json-download - Download a JSON file.
json-upload - Upload given data representing a JSON file to the database.
json-delete - Delete a single JSON file.
jsons-list - List the JSON files in the database.
jsons-count - Count the JSON files in the database.
jsons-download - Download JSON files from the database.
jsons-delete - Delete all the JSON files from the database.
metadata-view - Output the contents of a single metadata entry.