# MDE - Markdown Executor (1.3.3.1) --- - :arg_name: NAME :compreply: false :description: Name of block :env_var: MDE_BLOCK_NAME :long_name: block-name :opt_name: block_name :short_name: b :procname: val_as_str - :arg_name: PATH :default: "." :description: Read configuration file :long_name: config :procname: path - :arg_name: BOOL :default: false :description: Debug output :env_var: MDE_DEBUG :long_name: debug :short_name: d :procname: debug - :arg_name: RELATIVE_PATH :compreply: "." :description: Name of document :env_var: MDE_FILENAME :long_name: filename :opt_name: filename :short_name: f :procname: val_as_str - :description: App help :long_name: help :short_name: h :procname: help - :arg_name: RELATIVE_PATH :default: "." :description: Path to documents :env_var: MDE_PATH :long_name: path :opt_name: path :short_name: p :procname: val_as_str - :arg_name: BOOL :default: true :description: Pause for user to approve script :env_var: MDE_USER_MUST_APPROVE :long_name: user-must-approve :opt_name: user_must_approve :short_name: q :procname: val_as_bool - :description: Print the gem's version :long_name: version :short_name: v :procname: version - :description: Exit app :long_name: exit :short_name: x :procname: exit - :description: Show current configuration values :short_name: '0' :procname: show_config - :description: List blocks :long_name: list-blocks :opt_name: list_blocks :procname: val_as_bool - :description: List default configuration as environment variables :long_name: list-default-env :opt_name: list_default_env - :description: List default configuration as YAML :long_name: list-default-yaml :opt_name: list_default_yaml - :description: List docs in current folder :long_name: list-docs :opt_name: list_docs :procname: val_as_bool - :description: List recent saved output :long_name: list-recent-output :opt_name: list_recent_output :procname: val_as_bool - :description: List recent saved scripts :long_name: list-recent-scripts :opt_name: list_recent_scripts :procname: val_as_bool - :description: Select and execute a recently saved output :long_name: select-recent-output :opt_name: select_recent_output :procname: val_as_bool - :description: Select and execute a recently saved script :long_name: select-recent-script :opt_name: select_recent_script :procname: val_as_bool - :description: List tab completions :long_name: tab-completions :opt_name: tab_completions :procname: val_as_bool - :description: Run most recently saved script :long_name: run-last-script :opt_name: run_last_script :procname: val_as_bool - :description: Gem home folder :long_name: pwd :opt_name: pwd :procname: val_as_bool - :arg_name: BOOL :default: false :description: Display only blocks of type "bash" :env_var: MDE_BASH_ONLY :opt_name: bash_only :procname: val_as_bool - :arg_name: INT.0-3 :default: 1 :description: Output display level (0 to 3 [data, +context, +info]) :env_var: MDE_DISPLAY_LEVEL :long_name: display-level :opt_name: display_level :procname: val_as_int - :arg_name: REGEX :default: :description: Exclude blocks with name matching :env_var: MDE_EXCLUDE_BY_NAME_REGEX :opt_name: exclude_by_name_regex :procname: val_as_str - :arg_name: REGEX :default: :description: Exclude blocks with shell matching :env_var: MDE_EXCLUDE_BY_SHELL_REGEX :opt_name: exclude_by_shell_regex :procname: val_as_str - :arg_name: BOOL :default: true :description: Hide all blocks of type "expect" :env_var: MDE_EXCLUDE_EXPECT_BLOCKS :opt_name: exclude_expect_blocks :procname: val_as_bool - :arg_name: BOOL :default: true :description: |- Exclude blocks with name matching expression " \ "`block_name_hidden_match` :env_var: MDE_HIDE_BLOCKS_BY_NAME :opt_name: hide_blocks_by_name :procname: val_as_bool - :arg_name: INT.1- :default: 32 :description: Max. items to return in list :env_var: MDE_LIST_COUNT :long_name: list-count :opt_name: list_count :procname: val_as_int - :arg_name: PREFIX :default: mde :description: Name prefix for stdout files :env_var: MDE_LOGGED_STDOUT_FILENAME_PREFIX :opt_name: logged_stdout_filename_prefix :procname: val_as_str - :arg_name: BOOL :default: false :description: Display document name in block selection menu :env_var: MDE_MENU_BLOCKS_WITH_DOCNAME :opt_name: menu_blocks_with_docname :procname: val_as_bool - :arg_name: BOOL :default: false :description: Display headings (levels 1,2,3) in block selection menu :env_var: MDE_MENU_BLOCKS_WITH_HEADINGS :opt_name: menu_blocks_with_headings :procname: val_as_bool - :arg_name: BOOL :default: true :description: Display Exit option at top of menu :env_var: MDE_MENU_EXIT_AT_TOP :opt_name: menu_exit_at_top :procname: val_as_bool - :arg_name: BOOL :default: true :description: Display Exit option in menu :env_var: MDE_MENU_WITH_EXIT :opt_name: menu_with_exit :procname: val_as_bool - :arg_name: BOOL :default: false :description: Display summary for execution :env_var: MDE_OUTPUT_EXECUTION_SUMMARY :long_name: output-execution-summary :opt_name: output_execution_summary :procname: val_as_bool - :arg_name: BOOL :default: false :description: Output saved script filename at end of execution :env_var: MDE_OUTPUT_SAVED_SCRIPT_FILENAME :opt_name: output_saved_script_filename :procname: val_as_bool - :arg_name: BOOL :default: false :description: Display script prior to execution :env_var: MDE_OUTPUT_SCRIPT :long_name: output-script :opt_name: output_script :procname: val_as_bool - :arg_name: BOOL :default: true :description: Display standard output from execution :env_var: MDE_OUTPUT_STDOUT :long_name: output-stdout :opt_name: output_stdout :procname: val_as_bool - :arg_name: BOOL :default: false :description: Save executed script :env_var: MDE_SAVE_EXECUTED_SCRIPT :long_name: save-executed-script :opt_name: save_executed_script :procname: val_as_bool - :arg_name: BOOL :default: false :description: Save standard output of the executed script :env_var: MDE_SAVE_EXECUTION_OUTPUT :long_name: save-execution-output :opt_name: save_execution_output :procname: val_as_bool - :arg_name: INT :default: 493 :description: chmod for saved scripts :env_var: MDE_SAVED_SCRIPT_CHMOD :opt_name: saved_script_chmod :procname: val_as_int - :arg_name: PREFIX :default: mde :description: Name prefix for saved scripts :env_var: MDE_SAVED_SCRIPT_FILENAME_PREFIX :opt_name: saved_script_filename_prefix :procname: val_as_str - :arg_name: RELATIVE_PATH :default: logs :description: Saved script folder :env_var: MDE_SAVED_SCRIPT_FOLDER :long_name: saved-script-folder :opt_name: saved_script_folder :procname: val_as_str - :arg_name: GLOB :default: mde_*.sh :description: Glob matching saved scripts :env_var: MDE_SAVED_SCRIPT_GLOB :opt_name: saved_script_glob :procname: val_as_str - :arg_name: RELATIVE_PATH :default: logs :description: Saved stdout folder :env_var: MDE_SAVED_STDOUT_FOLDER :long_name: saved-stdout-folder :opt_name: saved_stdout_folder :procname: val_as_str - :arg_name: GLOB :default: mde_*.out.txt :description: Glob matching saved outputs :env_var: MDE_SAVED_STDOUT_GLOB :opt_name: saved_stdout_glob :procname: val_as_str - :arg_name: REGEX :default: :description: Select blocks with name matching :env_var: MDE_SELECT_BY_NAME_REGEX :opt_name: select_by_name_regex :procname: val_as_str - :arg_name: REGEX :default: :description: Select blocks with shell matching :env_var: MDE_SELECT_BY_SHELL_REGEX :opt_name: select_by_shell_regex :procname: val_as_str - :default: "^[\\(\\[].*[\\)\\]]$" :description: Pattern for blocks to hide from user-selection :env_var: MDE_BLOCK_NAME_HIDDEN_MATCH :opt_name: block_name_hidden_match :procname: val_as_str - :default: ":(?\\S+)( |$)" :env_var: MDE_BLOCK_NAME_MATCH :opt_name: block_name_match :procname: val_as_str - :default: "%\\([^\\)]+\\)" :env_var: MDE_BLOCK_CALLS_SCAN :opt_name: block_calls_scan :procname: val_as_str - :default: "\\+\\S+" :env_var: MDE_BLOCK_REQUIRED_SCAN :opt_name: block_required_scan :procname: val_as_str - :default: "<(?<full>(?<type>\\$)?(?<name>[A-Za-z_\\-\\.\\w]+))" :env_var: MDE_BLOCK_STDIN_SCAN :opt_name: block_stdin_scan :procname: val_as_str - :default: ">(?<full>(?<type>\\$)?(?<name>[A-Za-z_\\-\\.\\w]+))" :env_var: MDE_BLOCK_STDOUT_SCAN :opt_name: block_stdout_scan :procname: val_as_str - :default: "> " :env_var: MDE_DISPLAY_LEVEL_XBASE_PREFIX :opt_name: display_level_xbase_prefix :procname: val_as_str - :default: "^`{3,}" :env_var: MDE_FENCED_START_AND_END_MATCH :opt_name: fenced_start_and_end_match :procname: val_as_str - :default: "^`{3,}(?<shell>[^`\\s]*) *:?(?<name>[^\\s]*) *(?<rest>.*) *$" :env_var: MDE_FENCED_START_EX_MATCH :opt_name: fenced_start_ex_match :procname: val_as_str - :default: "^# *(?<name>[^#]*?) *$" :env_var: MDE_HEADING1_MATCH :opt_name: heading1_match :procname: val_as_str - :default: "^## *(?<name>[^#]*?) *$" :env_var: MDE_HEADING2_MATCH :opt_name: heading2_match :procname: val_as_str - :default: "^### *(?<name>.+?) *$" :env_var: MDE_HEADING3_MATCH :opt_name: heading3_match :procname: val_as_str - :default: "^ *@import (.+)$" :env_var: MDE_IMPORT_PATTERN :opt_name: import_pattern :procname: val_as_str - :default: "*.[Mm][Dd]" :env_var: MDE_MD_FILENAME_GLOB :opt_name: md_filename_glob :procname: val_as_str - :default: ".+\\.md" :env_var: MDE_MD_FILENAME_MATCH :opt_name: md_filename_match :procname: val_as_str - :default: "-:= %s =:-" :description: format for menu dividers and demarcations :env_var: MDE_MENU_DIVIDER_FORMAT :opt_name: menu_divider_format :procname: val_as_str - :default: magenta :description: Color of menu divider :env_var: MDE_MENU_DIVIDER_COLOR :opt_name: menu_divider_color :procname: val_as_str - :default: "^::: +(?<name>.+?)$" :description: Pattern for topics/dividers in block selection menu :env_var: MDE_MENU_DIVIDER_MATCH :opt_name: menu_divider_match :procname: val_as_str - :default: ">" :description: Symbol before each divider :env_var: MDE_MENU_DIVIDER_SYMBOL :opt_name: menu_divider_symbol :procname: val_as_str - :default: "~~~" :description: closing demarcations for menu :env_var: MDE_MENU_FINAL_DIVIDER :opt_name: menu_final_divider :procname: val_as_str - :default: '' :description: opening demarcation for menu :env_var: MDE_MENU_INITIAL_DIVIDER :opt_name: menu_initial_divider :procname: val_as_str - :description: Options for viewing saved output file :env_var: MDE_OUTPUT_VIEWER_OPTIONS :opt_name: output_viewer_options :procname: val_as_str - :default: 36 :description: 'Maximum # of rows in select list' :env_var: MDE_SELECT_PAGE_HEIGHT :opt_name: select_page_height :procname: val_as_int - :default: "#!/usr/bin/env" :description: Shebang for saved scripts :env_var: MDE_SHEBANG :opt_name: shebang :procname: val_as_str - :default: bash :description: Shell for launched scripts :env_var: MDE_SHELL :opt_name: shell :procname: val_as_str - :default: Process? :description: Prompt to approve a block :env_var: MDE_PROMPT_APPROVE_BLOCK :opt_name: prompt_approve_block :procname: val_as_str - :default: 'Choose a block:' :description: Prompt to select a block :env_var: MDE_PROMPT_SELECT_BLOCK :opt_name: prompt_select_block :procname: val_as_str - :default: 'Choose a file:' :description: Prompt to select a markdown document :env_var: MDE_PROMPT_SELECT_MD :opt_name: prompt_select_md :procname: val_as_str - :default: 'Choose a file:' :description: Prompt to select a saved file :env_var: MDE_PROMPT_SELECT_OUTPUT :opt_name: prompt_select_output :procname: val_as_str - :default: Copy script to clipboard :description: Prompt to copy script to clipboard :env_var: MDE_PROMPT_SCRIPT_TO_CLIPBOARD :opt_name: prompt_script_to_clipboard :procname: val_as_str - :default: Save script :description: Prompt to save script :env_var: MDE_PROMPT_SAVE_SCRIPT :opt_name: prompt_save_script :procname: val_as_str - :default: 'No' :description: Prompt for no :env_var: MDE_PROMPT_NO :opt_name: prompt_no :procname: val_as_str - :default: 'Yes' :description: Prompt for yes :env_var: MDE_PROMPT_YES :opt_name: prompt_yes :procname: val_as_str - :default: " #=#=#" :description: Output divider :env_var: MDE_OUTPUT_DIVIDER :opt_name: output_divider :procname: val_as_str - :default: yellow :description: Color of output divider :env_var: MDE_OUTPUT_DIVIDER_COLOR :opt_name: output_divider_color :procname: val_as_str