Table of Contents - runbook-1.1.0 Documentation
Pages
- dsl_extension.tt
- generator.tt
- Gemfile.tt
- README.md.tt
- Runbookfile.tt
- base_file.rb.tt
- runbook.tt
- statement.tt
Classes and Modules
- Object
- Runbook
- Runbook::AirbrusshContext
- Runbook::CLI
- Runbook::CLIBase
- Runbook::CLIBase::ClassMethods
- Runbook::Configuration
- Runbook::DSL
- Runbook::Entities
- Runbook::Entities::Book
- Runbook::Entities::Section
- Runbook::Entities::Setup
- Runbook::Entities::Step
- Runbook::Entity
- Runbook::Extensions
- Runbook::Extensions::Add
- Runbook::Extensions::Add::DSL
- Runbook::Extensions::Description
- Runbook::Extensions::Description::DSL
- Runbook::Extensions::SSHConfig
- Runbook::Extensions::SSHConfig::DSL
- Runbook::Extensions::Sections
- Runbook::Extensions::Sections::DSL
- Runbook::Extensions::Setup
- Runbook::Extensions::Setup::DSL
- Runbook::Extensions::SharedVariables
- Runbook::Extensions::SharedVariables::RunHooks
- Runbook::Extensions::Statements
- Runbook::Extensions::Statements::DSL
- Runbook::Extensions::Steps
- Runbook::Extensions::Steps::DSL
- Runbook::Extensions::Tmux
- Runbook::Extensions::Tmux::LayoutDSL
- Runbook::Generator
- Runbook::Generators
- Runbook::Generators::Base
- Runbook::Generators::Base::ClassMethods
- Runbook::Generators::DslExtension
- Runbook::Generators::Generator
- Runbook::Generators::Project
- Runbook::Generators::Runbook
- Runbook::Generators::Statement
- Runbook::Helpers
- Runbook::Helpers::FormatHelper
- Runbook::Helpers::SSHKitHelper
- Runbook::Helpers::TmuxHelper
- Runbook::Hooks
- Runbook::Hooks::Invoker
- Runbook::Initializer
- Runbook::Node
- Runbook::Run
- Runbook::Run::ClassMethods
- Runbook::Runner
- Runbook::Runs
- Runbook::Runs::SSHKit
- Runbook::Runs::SSHKit::ClassMethods
- Runbook::Statement
- Runbook::Statements
- Runbook::Statements::Ask
- Runbook::Statements::Assert
- Runbook::Statements::Capture
- Runbook::Statements::CaptureAll
- Runbook::Statements::Command
- Runbook::Statements::Confirm
- Runbook::Statements::Description
- Runbook::Statements::Download
- Runbook::Statements::Layout
- Runbook::Statements::Note
- Runbook::Statements::Notice
- Runbook::Statements::RubyCommand
- Runbook::Statements::TmuxCommand
- Runbook::Statements::Upload
- Runbook::Statements::Wait
- Runbook::Toolbox
- Runbook::Util
- Runbook::Util::Glue
- Runbook::Util::Repo
- Runbook::Util::StickyHash
- Runbook::Util::StoredPose
- Runbook::View
- Runbook::View::ClassMethods
- Runbook::Viewer
- Runbook::Views
- Runbook::Views::Markdown
Methods
- ::_child_classes — Runbook
- ::_child_modules — Runbook
- ::_copy_ivars_to_repo — Runbook::Extensions::SharedVariables::RunHooks
- ::_eqls_method — Runbook::Extensions::SharedVariables::RunHooks
- ::_file — Runbook::Util::Repo
- ::_file — Runbook::Util::StoredPose
- ::_load_cli_config — Runbook::Configuration
- ::_load_global_config — Runbook::Configuration
- ::_load_project_config — Runbook::Configuration
- ::_load_user_config — Runbook::Configuration
- ::_register_additional_step_whitespace_hook — Runbook::Run
- ::_register_kill_all_panes_hook — Runbook::Run
- ::_slug — Runbook::Util::Repo
- ::_slug — Runbook::Util::StoredPose
- ::_statement_class — Runbook::Extensions::Statements::DSL
- ::_target — Runbook::Extensions::SharedVariables::RunHooks
- ::_unique_class_options — Runbook::Generator
- ::blank_ssh_config — Runbook::Extensions::SSHConfig
- ::book — Runbook
- ::books — Runbook
- ::class — Runbook::DSL
- ::cli_config_file — Runbook::Configuration
- ::cli_config_file= — Runbook::Configuration
- ::config — Runbook
- ::configure — Runbook
- ::delete — Runbook::Util::Repo
- ::delete — Runbook::Util::StoredPose
- ::deprecator — Runbook
- ::description — Runbook::Generators::DslExtension
- ::description — Runbook::Generators::Generator
- ::description — Runbook::Generators::Project
- ::description — Runbook::Generators::Runbook
- ::description — Runbook::Generators::Statement
- ::dsl_ivars — Runbook::DSL
- ::entities — Runbook
- ::generators — Runbook
- ::included — Runbook::CLIBase
- ::included — Runbook::Generators::Base
- ::included — Runbook::Run
- ::included — Runbook::Runs::SSHKit
- ::included — Runbook::View
- ::inherited — Runbook::Entity
- ::initial_render_metadata — Runbook::Entities::Book
- ::initial_run_metadata — Runbook::Entities::Book
- ::load — Runbook::Util::Repo
- ::load — Runbook::Util::StoredPose
- ::load_config — Runbook::Configuration
- ::loaded — Runbook::Configuration
- ::loaded= — Runbook::Configuration
- ::long_description — Runbook::Generators::DslExtension
- ::long_description — Runbook::Generators::Project
- ::new — Runbook::AirbrusshContext
- ::new — Runbook::Configuration
- ::new — Runbook::Entities::Book
- ::new — Runbook::Entities::Section
- ::new — Runbook::Entities::Setup
- ::new — Runbook::Entities::Step
- ::new — Runbook::Entity
- ::new — Runbook::Runner
- ::new — Runbook::Node
- ::new — Runbook::Statements::Ask
- ::new — Runbook::Statements::Assert
- ::new — Runbook::Statements::Capture
- ::new — Runbook::Statements::CaptureAll
- ::new — Runbook::Statements::Command
- ::new — Runbook::Statements::Confirm
- ::new — Runbook::Statements::Description
- ::new — Runbook::Statements::Download
- ::new — Runbook::Statements::Layout
- ::new — Runbook::Statements::Note
- ::new — Runbook::Statements::Notice
- ::new — Runbook::Statements::RubyCommand
- ::new — Runbook::Statements::TmuxCommand
- ::new — Runbook::Statements::Upload
- ::new — Runbook::Statements::Wait
- ::new — Runbook::Toolbox
- ::new — Runbook::Util::Glue
- ::new — Runbook::Viewer
- ::new — Runbook::CLIBase
- ::new — Runbook::DSL
- ::reconfigure — Runbook::Configuration
- ::register — Runbook
- ::register_delete_stored_pose_hook — Runbook::Util::StoredPose
- ::register_delete_stored_repo_hook — Runbook::Util::Repo
- ::register_save_pose_hook — Runbook::Util::StoredPose
- ::register_save_repo_hook — Runbook::Util::Repo
- ::register_shared_variables_hooks — Runbook::Extensions::SharedVariables::RunHooks
- ::reset_configuration — Runbook
- ::runbook__entities__book — Runbook::Views::Markdown
- ::runbook__entities__section — Runbook::Views::Markdown
- ::runbook__entities__setup — Runbook::Views::Markdown
- ::runbook__entities__step — Runbook::Views::Markdown
- ::runbook__statements__ask — Runbook::Views::Markdown
- ::runbook__statements__assert — Runbook::Views::Markdown
- ::runbook__statements__capture — Runbook::Views::Markdown
- ::runbook__statements__capture_all — Runbook::Views::Markdown
- ::runbook__statements__command — Runbook::Views::Markdown
- ::runbook__statements__confirm — Runbook::Views::Markdown
- ::runbook__statements__description — Runbook::Views::Markdown
- ::runbook__statements__download — Runbook::Views::Markdown
- ::runbook__statements__layout — Runbook::Views::Markdown
- ::runbook__statements__note — Runbook::Views::Markdown
- ::runbook__statements__notice — Runbook::Views::Markdown
- ::runbook__statements__ruby_command — Runbook::Views::Markdown
- ::runbook__statements__tmux_command — Runbook::Views::Markdown
- ::runbook__statements__upload — Runbook::Views::Markdown
- ::runbook__statements__wait — Runbook::Views::Markdown
- ::runs — Runbook
- ::runtime_methods — Runbook
- ::save — Runbook::Util::Repo
- ::save — Runbook::Util::StoredPose
- ::section — Runbook
- ::set_base_options — Runbook::Generators::Base
- ::setup — Runbook
- ::statements — Runbook
- ::step — Runbook
- ::usage — Runbook::Generators::Generator
- ::usage — Runbook::Generators::Runbook
- ::views — Runbook
- #[] — Runbook::Util::StickyHash
- #[]= — Runbook::Util::StickyHash
- #__print_version — Runbook::CLI
- #_all_panes_exist? — Runbook::Helpers::TmuxHelper
- #_as_block — Runbook::Helpers::SSHKitHelper
- #_coordinator_options — Runbook::Helpers::SSHKitHelper
- #_execute_after_hooks — Runbook::Hooks::Invoker
- #_execute_around_hooks — Runbook::Hooks::Invoker
- #_execute_before_hooks — Runbook::Hooks::Invoker
- #_handle_capture — Runbook::Runs::SSHKit::ClassMethods
- #_handle_continue_result — Runbook::Run::ClassMethods
- #_hook_index — Runbook::Hooks
- #_initialize_panes — Runbook::Helpers::TmuxHelper
- #_keep_dir — Runbook::Generators::Project
- #_keep_dir — Runbook::Initializer
- #_kill_pane — Runbook::Helpers::TmuxHelper
- #_layout_file — Runbook::Helpers::TmuxHelper
- #_method_name — Runbook::Run::ClassMethods
- #_method_name — Runbook::View::ClassMethods
- #_name — Runbook::Generators::Project
- #_new_window — Runbook::Helpers::TmuxHelper
- #_pager_escape_sequence — Runbook::Helpers::TmuxHelper
- #_remove_stale_layouts — Runbook::Helpers::TmuxHelper
- #_rename_window — Runbook::Helpers::TmuxHelper
- #_render_metadata — Runbook::Entity
- #_resume_previous_pose? — Runbook::Runner
- #_retrieve_runbook — Runbook::CLI
- #_run_metadata — Runbook::Entity
- #_runbook_pane — Runbook::Helpers::TmuxHelper
- #_servers — Runbook::Helpers::SSHKitHelper
- #_session_layout_files — Runbook::Helpers::TmuxHelper
- #_session_panes — Runbook::Helpers::TmuxHelper
- #_set_cli_config — Runbook::CLIBase
- #_set_directory — Runbook::Helpers::TmuxHelper
- #_setup_layout — Runbook::Helpers::TmuxHelper
- #_setup_panes — Runbook::Helpers::TmuxHelper
- #_should_retraverse? — Runbook::Entity
- #_should_reverse? — Runbook::Entity
- #_slug — Runbook::Helpers::TmuxHelper
- #_split — Runbook::Helpers::TmuxHelper
- #_step_choices — Runbook::Run::ClassMethods
- #_stored_position — Runbook::Runner
- #_swap_panes — Runbook::Helpers::TmuxHelper
- #_swap_runbook_pane — Runbook::Helpers::TmuxHelper
- #_with_block — Runbook::Helpers::SSHKitHelper
- #_with_umask — Runbook::Helpers::SSHKitHelper
- #_within_block — Runbook::Helpers::SSHKitHelper
- #add — Runbook::Entity
- #add — Runbook::Extensions::Add::DSL
- #additional_metadata — Runbook::Runner
- #additional_metadata — Runbook::Viewer
- #as — Object
- #ask — Runbook::Toolbox
- #command — Runbook::Generators::Base::ClassMethods
- #create_base_file — Runbook::Generators::Project
- #create_dsl_extension — Runbook::Generators::DslExtension
- #create_extensions_directory — Runbook::Generators::Project
- #create_extensions_directory — Runbook::Initializer
- #create_gemfile — Runbook::Generators::Project
- #create_generator — Runbook::Generators::Generator
- #create_generator_directory — Runbook::Generators::Generator
- #create_generators_directory — Runbook::Generators::Project
- #create_generators_directory — Runbook::Initializer
- #create_lib_directory — Runbook::Generators::Project
- #create_lib_directory — Runbook::Initializer
- #create_readme — Runbook::Generators::Project
- #create_ruby_gemset — Runbook::Generators::Project
- #create_ruby_version — Runbook::Generators::Project
- #create_runbook — Runbook::Generators::Runbook
- #create_runbookfile — Runbook::Generators::Project
- #create_runbookfile — Runbook::Initializer
- #create_runbooks_directory — Runbook::Generators::Project
- #create_runbooks_directory — Runbook::Initializer
- #create_statement — Runbook::Generators::Statement
- #create_templates_directory — Runbook::Generators::Generator
- #deindent — Runbook::Helpers::FormatHelper
- #description — Runbook::Extensions::Description::DSL
- #description — Runbook::Generators::Base::ClassMethods
- #dynamic! — Runbook::Entity
- #dynamic! — Runbook::Node
- #dynamic? — Runbook::Node
- #env — Runbook::Extensions::SSHConfig::DSL
- #error — Runbook::Toolbox
- #exec — Runbook::CLI
- #execute — Runbook::Run::ClassMethods
- #exit — Runbook::Toolbox
- #exit_on_failure? — Runbook::CLIBase::ClassMethods
- #expand — Runbook::Toolbox
- #find_ssh_config — Runbook::Helpers::SSHKitHelper
- #generate — Runbook::Viewer
- #group — Runbook::Extensions::SSHConfig::DSL
- #hooks — Runbook::Hooks
- #hooks_for — Runbook::Hooks
- #init — Runbook::CLI
- #init_gem — Runbook::Generators::Project
- #invoke_with_hooks — Runbook::Hooks::Invoker
- #items — Runbook::Entity
- #kill_all_panes — Runbook::Helpers::TmuxHelper
- #layout — Runbook::Extensions::Tmux::LayoutDSL
- #long_description — Runbook::Generators::Base::ClassMethods
- #method_missing — Runbook::Entity
- #method_missing — Runbook::Extensions::Statements::DSL
- #modify_rakefile — Runbook::Generators::Project
- #options — Runbook::Generators::Base::ClassMethods
- #output — Runbook::Toolbox
- #parallelization — Runbook::Extensions::SSHConfig::DSL
- #parent_entity — Runbook::Node
- #password_cache_key — Runbook::Configuration
- #past_position? — Runbook::Run::ClassMethods
- #path — Runbook::Extensions::SSHConfig::DSL
- #position — Runbook::AirbrusshContext
- #register_hook — Runbook::Hooks
- #register_new_command — Runbook::AirbrusshContext
- #remove_bad_test — Runbook::Generators::Project
- #remove_unneeded_files — Runbook::Generators::Project
- #render — Runbook::Entity
- #render — Runbook::Statement
- #render — Runbook::View::ClassMethods
- #render_ssh_config_output — Runbook::Helpers::SSHKitHelper
- #respond_to? — Runbook::Entity
- #respond_to? — Runbook::Extensions::Statements::DSL
- #run — Runbook::Entity
- #run — Runbook::Runner
- #run — Runbook::Statement
- #runbook__entities__book — Runbook::Run::ClassMethods
- #runbook__entities__section — Runbook::Run::ClassMethods
- #runbook__entities__setup — Runbook::Run::ClassMethods
- #runbook__entities__step — Runbook::Run::ClassMethods
- #runbook__entities__step — Runbook::Runs::SSHKit::ClassMethods
- #runbook__statements__ask — Runbook::Run::ClassMethods
- #runbook__statements__assert — Runbook::Runs::SSHKit::ClassMethods
- #runbook__statements__capture — Runbook::Runs::SSHKit::ClassMethods
- #runbook__statements__capture_all — Runbook::Runs::SSHKit::ClassMethods
- #runbook__statements__command — Runbook::Runs::SSHKit::ClassMethods
- #runbook__statements__confirm — Runbook::Run::ClassMethods
- #runbook__statements__description — Runbook::Run::ClassMethods
- #runbook__statements__download — Runbook::Runs::SSHKit::ClassMethods
- #runbook__statements__layout — Runbook::Run::ClassMethods
- #runbook__statements__note — Runbook::Run::ClassMethods
- #runbook__statements__notice — Runbook::Run::ClassMethods
- #runbook__statements__ruby_command — Runbook::Run::ClassMethods
- #runbook__statements__tmux_command — Runbook::Run::ClassMethods
- #runbook__statements__upload — Runbook::Runs::SSHKit::ClassMethods
- #runbook__statements__wait — Runbook::Run::ClassMethods
- #runbook_initialization_overview — Runbook::Initializer
- #runbook_project_overview — Runbook::Generators::Project
- #section — Runbook::Extensions::Sections::DSL
- #send_keys — Runbook::Helpers::TmuxHelper
- #server — Runbook::Extensions::SSHConfig::DSL
- #servers — Runbook::Extensions::SSHConfig::DSL
- #set_current_task_name — Runbook::AirbrusshContext
- #setup — Runbook::Extensions::Setup::DSL
- #setup_layout — Runbook::Helpers::TmuxHelper
- #shared_lib_dir — Runbook::Generators::Project
- #should_skip? — Runbook::Run::ClassMethods
- #ssh_config — Runbook::Extensions::SSHConfig
- #ssh_config — Runbook::Extensions::SSHConfig::DSL
- #ssh_kit_command — Runbook::Helpers::SSHKitHelper
- #ssh_kit_command_options — Runbook::Helpers::SSHKitHelper
- #start_at_is_substep? — Runbook::Run::ClassMethods
- #step — Runbook::Extensions::Steps::DSL
- #timeout_statement — Runbook::Statements::Assert
- #umask — Runbook::Extensions::SSHConfig::DSL
- #update_bin_console — Runbook::Generators::Project
- #usage — Runbook::Generators::Base::ClassMethods
- #use_same_sudo_password= — Runbook::Configuration
- #user — Runbook::Extensions::SSHConfig::DSL
- #view — Runbook::CLI
- #visited! — Runbook::Node
- #visited? — Runbook::Node
- #warn — Runbook::Toolbox
- #with_ssh_config — Runbook::Helpers::SSHKitHelper
- #yes? — Runbook::Toolbox