Documentation on CLI and the actual CLI `:help` command inconsistent (hashtag2813)

[vikramsubramanian]

It looks like our [CLI documentation]( is out of date. On the documentation page it gives the following options:

kuzu> :help
    :help     get command list
    :clear     clear shell
    :quit     exit from shell
    :thread [num_threads]     set number of threads for query execution
    :logging_level [logging_level]     set logging level of database, available options: debug, info, err
    :timeout [query_timeout]     set query timeout in ms
    :list_nodes     list all node tables
    :list_rels     list all rel tables
    :show_node     [table_name] show node schema
    :show_rel     [table_name] show rel schema

The actual CLI has these options (and they're about the change as well):

kuzu> :help
    :help     get command list
    :clear     clear shell
    :quit     exit from shell
    :thread [num_threads]     set number of threads for query execution
    :logging_level [logging_level]     set logging level of database, available options: debug, info, err
    :timeout [query_timeout]     set query timeout in ms

So all documentation about no longer supported things should be removed and if there is additional documentation we should add, they should be added (e.g., the CALL commands for configs: see the comment in this issue: )

[mayil-ai[bot]]

Summary: Inconsistency between the CLI documentation and the actual CLI commands.

Possible Solution

• Update the CLI documentation to reflect the current state of the CLI commands, ensuring consistency with the actual :help command output.
• Remove the :list_nodes, :list_rels, :show_node, and :show_rel commands from the documentation if they are no longer supported.
• Add documentation for any new commands related to CALL for configs that are missing.
• Ensure that the EmbeddedShell::printHelp() function in embedded_shell.cpp includes all current commands and their descriptions accurately.
• If there are upcoming changes to the CLI options, make sure to include a note or section in the documentation about these pending updates.
• Verify that the ShellCommand struct in embedded_shell.cpp and the printHelp() function are in sync with the actual supported commands.
• If the generate_help_output() function is used to generate the help output, ensure it pulls the correct and updated list of commands from the ShellCommand struct.
• If there is a documentation generator or updater function like update_documentation(), ensure it is being called with the correct list of commands after any updates to the CLI.
• Check for any discrepancies between the CLI documentation and the actual CLI output, and resolve them by updating the documentation or the CLI help output as needed.
• Tag the commit or pull request that resolves this issue with the issue number (hashtag2813) for traceability.

Code snippets to check

• tools/shell/embedded_shell.cpp

  This file contains the actual implementation of the CLI :help command which is inconsistent with the documentation.

• CONTRIBUTING.md

  This file may need to be updated if there are guidelines for updating documentation or if the contribution process involves documentation changes.