Table of Contents - bashly-1.2.6 Documentation
Pages
- README
- completely.yaml
- completely.yaml.gtx
- colors.sh
- config.sh
- help_command.sh
- after.sh
- before.sh
- initialize.sh
- ini.sh
- sample_function.sh
- README
- mandoc.gtx
- summary
- README
- markdown.gtx
- summary
- approvals.bash
- approve
- validate_dir_exists.sh
- validate_file_exists.sh
- validate_integer.sh
- validate_not_empty.sh
- yaml.sh
- README
- case.gtx
- case_repeatable.gtx
- usage.gtx
- validations.gtx
- catch_all_filter.gtx
- command_fallback.gtx
- command_filter.gtx
- command_functions.gtx
- default_assignments.gtx
- default_root_script.gtx
- default_script.gtx
- dependencies_filter.gtx
- environment_variables_default.gtx
- environment_variables_filter.gtx
- examples_on_error.gtx
- fixed_flags_filter.gtx
- footer.gtx
- function.gtx
- initialize.gtx
- inspect_args.gtx
-
long_usage.gtx
- view_marker
- render(:usage_flags).indent 2 if flags.any?
- render(:usage_fixed_flags).indent 2
- render(:usage_args).indent 2 if args.any? or catch_all.help
- render(:usage_environment_variables).indent 2 if environment_variables.any?
- render(:usage_examples).indent 2 if examples
- render(:footer).indent 2 if footer
- master_script.gtx
- needy_flags_filter.gtx
- normalize_input.gtx
- normalize_input_function.gtx
- normalize_input_simple.gtx
-
parse_requirements.gtx
- view_marker
- render(:fixed_flags_filter).indent 2
- render(:environment_variables_filter).indent 2
- render(:dependencies_filter).indent 2
- render(:command_filter).indent 2
- render(:parse_requirements_while).indent 2
- render(:required_args_filter).indent 2
- render(:required_flags_filter).indent 2
- render(:needy_flags_filter).indent 2
- render(:catch_all_filter).indent 2
- render(:default_assignments).indent 2
- render(:validations).indent 2
- render(:whitelist_filter).indent 2
- render(:user_filter).indent 2
- parse_requirements_case.gtx
- parse_requirements_case_catch_all.gtx
- parse_requirements_case_repeatable.gtx
- parse_requirements_case_simple.gtx
- parse_requirements_while.gtx
- required_args_filter.gtx
- required_flags_filter.gtx
- root_command.gtx
- run.gtx
- usage.gtx
- usage_args.gtx
- usage_commands.gtx
- usage_environment_variables.gtx
- usage_examples.gtx
- usage_fixed_flags.gtx
- usage_flags.gtx
- user_filter.gtx
- user_hooks.gtx
- user_lib.gtx
- validations.gtx
- variables.gtx
- version_command.gtx
- whitelist_filter.gtx
- usage.gtx
- validations.gtx
- case.gtx
- case_arg.gtx
- case_no_arg.gtx
- conflicts.gtx
- needs.gtx
- usage.gtx
- validations.gtx
- definition.gtx
- bash3_bouncer.gtx
- header.gtx
- wrapper.gtx
Classes and Modules
- Array
- Bashly
- Bashly::AssetHelper
- Bashly::CLI
- Bashly::Commands
- Bashly::Commands::Add
- Bashly::Commands::Base
- Bashly::Commands::Completions
- Bashly::Commands::Doc
- Bashly::Commands::Generate
- Bashly::Commands::Init
- Bashly::Commands::Preview
- Bashly::Commands::Render
- Bashly::Commands::Shell
- Bashly::Commands::Validate
- Bashly::Completions
- Bashly::Completions::Command
- Bashly::Completions::Flag
- Bashly::ComposeRefinements
- Bashly::Config
- Bashly::ConfigValidator
- Bashly::ConfigurationError
- Bashly::Error
- Bashly::IndentationHelper
- Bashly::InitError
- Bashly::Interrupt
- Bashly::Libraries
- Bashly::Libraries::Base
- Bashly::Libraries::CompletionsFunction
- Bashly::Libraries::CompletionsScript
- Bashly::Libraries::CompletionsYAML
- Bashly::Libraries::Help
- Bashly::Library
- Bashly::LibrarySource
- Bashly::LibrarySourceConfig
- Bashly::MessageStrings
- Bashly::RenderContext
- Bashly::RenderSource
- Bashly::Renderable
- Bashly::Script
- Bashly::Script::Argument
- Bashly::Script::Base
- Bashly::Script::CatchAll
- Bashly::Script::Command
- Bashly::Script::Dependency
- Bashly::Script::EnvironmentVariable
- Bashly::Script::Flag
- Bashly::Script::Introspection
- Bashly::Script::Introspection::Arguments
- Bashly::Script::Introspection::Commands
- Bashly::Script::Introspection::Dependencies
- Bashly::Script::Introspection::EnvironmentVariables
- Bashly::Script::Introspection::Examples
- Bashly::Script::Introspection::Flags
- Bashly::Script::Introspection::Variables
- Bashly::Script::Introspection::Visibility
- Bashly::Script::Variable
- Bashly::Script::Wrapper
- Bashly::Settings
- Bashly::ValidationHelpers
- File
- String
- YAML
Methods
- ::append — File
- ::commands_dir — Bashly::Settings
- ::compact_short_flags — Bashly::Settings
- ::config — Bashly::Settings
- ::config_path — Bashly::Settings
- ::conjoined_flag_args — Bashly::Settings
- ::deep_write — File
- ::default_settings_path — Bashly::Settings
- ::defsult_settings — Bashly::Settings
- ::env — Bashly::Settings
- ::env= — Bashly::Settings
- ::env_value — Bashly::Settings
- ::from_config — Bashly::Script::CatchAll
- ::from_config — Bashly::Script::Dependency
- ::full_lib_dir — Bashly::Settings
- ::get — Bashly::Settings
- ::internal — Bashly::RenderSource
- ::internal_dirs — Bashly::RenderSource
- ::internal_root — Bashly::RenderSource
- ::lib_dir — Bashly::Settings
- ::load_erb_file — YAML
- ::new — Bashly::IndentationHelper
- ::new — Bashly::Config
- ::new — Bashly::ConfigValidator
- ::new — Bashly::Libraries::Base
- ::new — Bashly::Library
- ::new — Bashly::LibrarySource
- ::new — Bashly::LibrarySourceConfig
- ::new — Bashly::RenderContext
- ::new — Bashly::RenderSource
- ::new — Bashly::Script::Base
- ::new — Bashly::Script::CatchAll
- ::new — Bashly::Script::Dependency
- ::new — Bashly::Script::Wrapper
- ::option_keys — Bashly::Script::Argument
- ::option_keys — Bashly::Script::Base
- ::option_keys — Bashly::Script::CatchAll
- ::option_keys — Bashly::Script::Command
- ::option_keys — Bashly::Script::Dependency
- ::option_keys — Bashly::Script::EnvironmentVariable
- ::option_keys — Bashly::Script::Flag
- ::option_keys — Bashly::Script::Variable
- ::partials_extension — Bashly::Settings
- ::private_reveal_key — Bashly::Settings
- ::production? — Bashly::Settings
- ::runner — Bashly::CLI
- ::show_examples_on_error — Bashly::Settings
- ::source_dir — Bashly::Settings
- ::strict — Bashly::Settings
- ::strict_string — Bashly::Settings
- ::tab_indent — Bashly::Settings
- ::target_dir — Bashly::Settings
- ::usage_colors — Bashly::Settings
- ::user_settings — Bashly::Settings
- ::user_settings_path — Bashly::Settings
- #[] — Bashly::MessageStrings
- #action_name — Bashly::Script::Command
- #add_lib — Bashly::Commands::Add
- #add_library_files — Bashly::Commands::Add
- #aliases — Bashly::Script::Command
- #aliases — Bashly::Script::Flag
- #alt — Bashly::Script::Command
- #args — Bashly::Script::Introspection::Arguments
- #assert — Bashly::ValidationHelpers
- #assert_arg — Bashly::ConfigValidator
- #assert_array — Bashly::ValidationHelpers
- #assert_boolean — Bashly::ValidationHelpers
- #assert_catch_all — Bashly::ConfigValidator
- #assert_catch_all_hash — Bashly::ConfigValidator
- #assert_command — Bashly::ConfigValidator
- #assert_default_command — Bashly::ConfigValidator
- #assert_dependencies — Bashly::ConfigValidator
- #assert_dependencies_hash — Bashly::ConfigValidator
- #assert_dependency — Bashly::ConfigValidator
- #assert_env_var — Bashly::ConfigValidator
- #assert_expose — Bashly::ConfigValidator
- #assert_extensible — Bashly::ConfigValidator
- #assert_filespec — Bashly::LibrarySourceConfig
- #assert_flag — Bashly::ConfigValidator
- #assert_hash — Bashly::ValidationHelpers
- #assert_lib — Bashly::LibrarySourceConfig
- #assert_optional_string — Bashly::ValidationHelpers
- #assert_root — Bashly::LibrarySourceConfig
- #assert_string — Bashly::ValidationHelpers
- #assert_string_or_array — Bashly::ValidationHelpers
- #assert_uniq — Bashly::ValidationHelpers
- #assert_var — Bashly::ConfigValidator
- #assert_version — Bashly::ConfigValidator
- #asset — Bashly::AssetHelper
- #asset_content — Bashly::AssetHelper
- #autocomplete — Bashly::Commands::Shell
- #base_code — Bashly::Script::Wrapper
- #base_usage_pattern — Bashly::Script::Command
- #base_views_path — Bashly::Renderable
- #body — Bashly::Script::Wrapper
- #caption_string — Bashly::Script::Command
- #catch_all — Bashly::Script::Command
- #cleanup — Bashly::LibrarySource
- #code — Bashly::Script::Wrapper
- #color — String
- #command — Bashly::Commands::Generate
- #command — Bashly::Libraries::Base
- #command — Bashly::RenderContext
- #command_aliases — Bashly::Script::Introspection::Commands
- #command_help_data — Bashly::Script::Introspection::Commands
- #command_names — Bashly::Script::Introspection::Commands
- #commands — Bashly::Script::Introspection::Commands
- #completion_allowed_args — Bashly::Completions::Command
- #completion_data — Bashly::Completions::Flag
- #completion_data — Bashly::Completions::Command
- #completion_flag_names — Bashly::Completions::Command
- #completion_full_names — Bashly::Completions::Command
- #completion_function — Bashly::Completions::Command
- #completion_generator — Bashly::Completions::Command
- #completion_script — Bashly::Completions::Command
- #completion_words — Bashly::Completions::Command
- #completions_function_code — Bashly::Libraries::CompletionsFunction
- #compose — Bashly::ComposeRefinements
- #config — Bashly::Commands::Base
- #config — Bashly::Libraries::Base
- #config — Bashly::LibrarySource
- #config — Bashly::RenderContext
- #config_path — Bashly::LibrarySource
- #config_validator — Bashly::Commands::Base
- #create_all_command_files — Bashly::Commands::Generate
- #create_file — Bashly::Commands::Generate
- #create_master_script — Bashly::Commands::Generate
- #create_root_command_file — Bashly::Commands::Generate
- #create_user_files — Bashly::Commands::Generate
- #custom_handler — Bashly::Library
- #custom_header_path — Bashly::Script::Wrapper
- #data — Bashly::Commands::Doc
- #data — Bashly::LibrarySourceConfig
- #deep_commands — Bashly::Script::Introspection::Commands
- #default_args — Bashly::Script::Introspection::Arguments
- #default_command — Bashly::Script::Introspection::Commands
- #default_environment_variables — Bashly::Script::Introspection::EnvironmentVariables
- #default_flags — Bashly::Script::Introspection::Flags
- #default_header — Bashly::Script::Wrapper
- #default_string — Bashly::Script::Argument
- #default_string — Bashly::Script::Flag
- #dependencies — Bashly::Script::Introspection::Dependencies
- #docs_dir — Bashly::Commands::Doc
- #enabled? — Bashly::Script::CatchAll
- #environment_variables — Bashly::Script::Introspection::EnvironmentVariables
- #examples — Bashly::Script::Introspection::Examples
- #exist? — Bashly::RenderSource
- #expand_tabs — String
- #extract_heredoc_marker — Bashly::IndentationHelper
- #file_contents — Bashly::Library
- #filename — Bashly::Script::Command
- #files — Bashly::Libraries::Base
- #files — Bashly::Libraries::CompletionsFunction
- #files — Bashly::Libraries::CompletionsScript
- #files — Bashly::Libraries::CompletionsYAML
- #files — Bashly::Libraries::Help
- #files — Bashly::Library
- #find_file — Bashly::Library
- #flags — Bashly::Script::Introspection::Flags
- #for_manpage — String
- #for_markdown — String
- #full_name — Bashly::Script::Command
- #function_name — Bashly::Libraries::CompletionsFunction
- #function_name — Bashly::Script::Command
- #generate — Bashly::Commands::Generate
- #generate_all_files — Bashly::Commands::Generate
- #generated_files — Bashly::Commands::Generate
- #git? — Bashly::LibrarySource
- #git_clone — Bashly::LibrarySource
- #git_specs — Bashly::LibrarySource
- #global_flags? — Bashly::Script::Introspection::Flags
- #group_string — Bashly::Script::Command
- #grouped_commands — Bashly::Script::Introspection::Commands
- #has_unique_args_or_flags? — Bashly::Script::Command
- #header — Bashly::Script::Wrapper
- #header! — Bashly::Script::Wrapper
- #help — Bashly::Script::Base
- #help — Bashly::Script::CatchAll
- #help_command — Bashly::Libraries::Help
- #heredoc_closed? — Bashly::IndentationHelper
- #implicit_filename — Bashly::Script::Command
- #include_sequence? — Array
- #indent — Bashly::IndentationHelper
- #indent — Array
- #indent — String
- #inside_heredoc? — Bashly::IndentationHelper
- #install_completions — Bashly::Commands::Completions
- #installer — Bashly::Commands::Completions
- #internal? — Bashly::RenderSource
- #internal_root — Bashly::RenderSource
- #label — Bashly::Script::Argument
- #label — Bashly::Script::CatchAll
- #lib_source — Bashly::Commands::Add
- #libraries — Bashly::LibrarySource
- #lint — String
- #load_user_file — Bashly::Renderable
- #master_script_path — Bashly::Commands::Generate
- #method_missing — Bashly::Script::Base
- #mode — Bashly::Script::Command
- #multi? — Bashly::Script::Dependency
- #name — Bashly::Script::Dependency
- #name — Bashly::Script::Flag
- #needy_flags — Bashly::Script::Introspection::Flags
- #nl2br — String
- #nonuniq — Array
- #optional — Bashly::Script::Base
- #parents — Bashly::Script::Command
- #path — Bashly::LibrarySource
- #path — Bashly::RenderSource
- #post_install_message — Bashly::Libraries::Base
- #post_install_message — Bashly::Libraries::CompletionsFunction
- #post_install_message — Bashly::Libraries::CompletionsScript
- #post_install_message — Bashly::Libraries::CompletionsYAML
- #post_install_message — Bashly::Libraries::Help
- #post_install_message — Bashly::Library
- #project_strings — Bashly::MessageStrings
- #project_strings! — Bashly::MessageStrings
- #project_strings_path — Bashly::MessageStrings
- #public_command_aliases — Bashly::Script::Introspection::Commands
- #public_commands — Bashly::Script::Introspection::Commands
- #public_environment_variables — Bashly::Script::Introspection::EnvironmentVariables
- #public_flags — Bashly::Script::Introspection::Flags
- #quiet_say — Bashly::Commands::Generate
- #raw_data — Bashly::Commands::Doc
- #readme — Bashly::RenderSource
- #readme_file — Bashly::RenderSource
- #refute — Bashly::ValidationHelpers
- #remove_front_matter — String
- #render — Bashly::Commands::Render
- #render — Bashly::RenderSource
- #render — Bashly::Renderable
- #render_script — Bashly::RenderSource
- #render_source — Bashly::Commands::Render
- #repeatable_arg_exist? — Bashly::Script::Introspection::Arguments
- #required? — Bashly::Script::CatchAll
- #required_args — Bashly::Script::Introspection::Arguments
- #required_environment_variables — Bashly::Script::Introspection::EnvironmentVariables
- #required_flags — Bashly::Script::Introspection::Flags
- #reset — Bashly::Commands::Generate
- #reset_marker — Bashly::IndentationHelper
- #respond_to_missing? — Bashly::Script::Base
- #root_command? — Bashly::Script::Command
- #run — Bashly::Commands::Add
- #run — Bashly::Commands::Completions
- #run — Bashly::Commands::Doc
- #run — Bashly::Commands::Generate
- #run — Bashly::Commands::Init
- #run — Bashly::Commands::Preview
- #run — Bashly::Commands::Render
- #run — Bashly::Commands::Shell
- #run — Bashly::Commands::Validate
- #runner — Bashly::Commands::Shell
- #safe_load_yaml — Bashly::ComposeRefinements
- #safe_run — Bashly::LibrarySource
- #safe_write — Bashly::Commands::Add
- #sanitize_for_print — String
- #save — Bashly::RenderContext
- #script — Bashly::Commands::Completions
- #script — Bashly::Commands::Generate
- #script_path — Bashly::Commands::Completions
- #selector — Bashly::Commands::Render
- #self_views_path — Bashly::Renderable
- #set_heredoc_state — Bashly::IndentationHelper
- #short_flag_exist? — Bashly::Script::Introspection::Flags
- #show — Bashly::Commands::Doc
- #show_about — Bashly::Commands::Render
- #show_example — Bashly::Commands::Doc
- #show_help — Bashly::Commands::Doc
- #show_key — Bashly::Commands::Doc
- #show_list — Bashly::Commands::Add
- #show_list — Bashly::Commands::Render
- #show_url — Bashly::Commands::Doc
- #source — Bashly::Commands::Add
- #start_render — Bashly::Commands::Render
- #strings — Bashly::Renderable
- #summary — Bashly::RenderSource
- #summary — Bashly::Script::Base
- #summary_file — Bashly::RenderSource
- #summary_string — Bashly::Script::Command
- #target_dir — Bashly::Commands::Init
- #target_file_args — Bashly::Library
- #target_path — Bashly::Libraries::CompletionsScript
- #target_path — Bashly::Libraries::CompletionsYAML
- #terminal — Bashly::Commands::Shell
- #to_hyphen — String
- #to_path — String
- #to_underscore — String
- #transform_github_uri — Bashly::LibrarySource
- #uninstall_completions — Bashly::Commands::Completions
- #upgrade — Bashly::Commands::Generate
- #upgrade! — Bashly::Commands::Generate
- #upgrade_libs — Bashly::Commands::Generate
- #usage_string — Bashly::Script::Argument
- #usage_string — Bashly::Script::CatchAll
- #usage_string — Bashly::Script::Command
- #usage_string — Bashly::Script::EnvironmentVariable
- #usage_string — Bashly::Script::Flag
- #usage_string_args — Bashly::Script::Introspection::Arguments
- #user_file_exist? — Bashly::Renderable
- #user_file_path — Bashly::Renderable
- #user_lib — Bashly::Script::Command
- #validatables — Bashly::Script::Command
- #validate — Bashly::ConfigValidator
- #validate — Bashly::LibrarySourceConfig
- #validate_config — Bashly::Commands::Base
- #validated_data — Bashly::LibrarySourceConfig
- #validated_environment_variables — Bashly::Script::Introspection::EnvironmentVariables
- #values — Bashly::MessageStrings
- #values! — Bashly::MessageStrings
- #variables — Bashly::Script::Introspection::Variables
- #view_marker — Bashly::Renderable
- #view_path — Bashly::Renderable
- #views_subfolder — Bashly::Renderable
- #visibility — Bashly::Script::Introspection::Visibility
- #visible_command_aliases — Bashly::Script::Introspection::Commands
- #visible_commands — Bashly::Script::Introspection::Commands
- #visible_environment_variables — Bashly::Script::Introspection::EnvironmentVariables
- #visible_flags — Bashly::Script::Introspection::Flags
- #watch — Bashly::Commands::Generate
- #watch — Bashly::Commands::Render
- #watchables — Bashly::Commands::Render
- #whitelisted_args — Bashly::Script::Introspection::Arguments
- #whitelisted_environment_variables — Bashly::Script::Introspection::EnvironmentVariables
- #whitelisted_flags — Bashly::Script::Introspection::Flags
- #with_valid_config — Bashly::Commands::Base
- #wrap — String
- #yaml_content — Bashly::Commands::Init
- #yaml_content! — Bashly::Commands::Init