API Reference

See also

See libtmux’s API and Quickstart to see how you can control tmux via python API calls.

• Internals
  • Colors - tmuxp._internal.colors
    • ColorMode
      • AUTO
      • ALWAYS
      • NEVER
    • Colors
      • SUCCESS
      • WARNING
      • ERROR
      • INFO
      • HEADING
      • HIGHLIGHT
      • MUTED
      • SUCCESS
      • WARNING
      • ERROR
      • INFO
      • HEADING
      • HIGHLIGHT
      • MUTED
      • _should_enable()
      • _colorize()
      • success()
      • warning()
      • error()
      • info()
      • highlight()
      • muted()
      • heading()
      • format_label()
      • format_path()
      • format_version()
      • format_separator()
      • format_rule()
      • format_kv()
      • format_tmux_option()
    • get_color_mode()
    • strip_ansi()
    • _interpret_color()
    • UnknownStyleColor
    • style()
    • unstyle()
    • build_description()
  • Config reader - tmuxp._internal.config_reader
    • ConfigReader
      • _load()
      • load()
      • _from_file()
      • from_file()
      • _dump()
      • dump()
  • Private path - tmuxp._internal.private_path
    • PrivatePath
      • _collapse_home()
    • collapse_home_in_string()
  • Typings - tmuxp._internal.types
    • PluginConfigSchema
      • plugin_name
      • tmux_min_version
      • tmux_max_version
      • tmux_version_incompatible
      • libtmux_min_version
      • libtmux_max_version
      • libtmux_version_incompatible
      • tmuxp_min_version
      • tmuxp_max_version
      • tmuxp_version_incompatible
• CLI
  • tmuxp convert - tmuxp.cli.convert
    • create_convert_subparser()
    • ConvertUnknownFileType
    • command_convert()
  • tmuxp debug-info - tmuxp.cli.debug_info
    • CLIDebugInfoNamespace
      • color
      • output_json
    • create_debug_info_subparser()
    • _private()
    • _collect_debug_info()
    • _format_human_output()
    • command_debug_info()
  • tmuxp edit - tmuxp.cli.edit
    • create_edit_subparser()
    • command_edit()
  • tmuxp freeze - tmuxp.cli.freeze
    • CLIFreezeNamespace
      • color
      • session_name
      • socket_name
      • socket_path
      • workspace_format
      • save_to
      • answer_yes
      • quiet
      • force
    • create_freeze_subparser()
    • command_freeze()
  • tmuxp import - tmuxp.cli.import_config
    • get_tmuxinator_dir()
    • get_teamocil_dir()
    • _resolve_path_no_overwrite()
    • command_import()
    • create_import_subparser()
    • ImportConfigFn
      • _abc_impl
      • _is_protocol
    • import_config()
    • command_import_tmuxinator()
    • command_import_teamocil()
  • tmuxp load - tmuxp.cli.load
    • _silence_stream_handlers()
    • CLILoadNamespace
      • workspace_files
      • socket_name
      • socket_path
      • tmux_config_file
      • new_session_name
      • answer_yes
      • detached
      • append
      • colors
      • color
      • log_file
      • log_level
      • progress_format
      • panel_lines
      • no_progress
    • load_plugins()
    • _reattach()
    • _load_attached()
    • _load_detached()
    • _load_append_windows_to_current_session()
    • _setup_plugins()
    • _dispatch_build()
    • load_workspace()
    • create_load_subparser()
    • command_load()
  • tmuxp ls - tmuxp.cli.ls
    • WorkspaceInfo
      • name
      • path
      • format
      • size
      • mtime
      • session_name
      • source
      • name
      • path
      • format
      • size
      • mtime
      • session_name
      • source
    • CLILsNamespace
      • color
      • tree
      • output_json
      • output_ndjson
      • full
    • create_ls_subparser()
    • _get_workspace_info()
    • _render_config_tree()
    • _render_global_workspace_dirs()
    • _output_flat()
    • _output_tree()
    • command_ls()
  • tmuxp progress - tmuxp.cli._progress
    • _visible_len()
    • _truncate_visible()
    • render_bar()
    • _SafeFormatMap
    • resolve_progress_format()
    • _WindowStatus
      • name
      • done
      • pane_num
      • pane_total
      • pane_done
    • BuildTree
      • on_event()
      • render()
      • _context()
      • format_template()
      • format_inline()
    • Spinner
      • _should_enable()
      • _restore_cursor()
      • _spin()
      • add_output_line()
      • update_message()
      • _build_extra()
      • on_build_event()
      • start()
      • stop()
      • format_success()
      • success()
  • tmuxp search - tmuxp.cli.search
    • FIELD_ALIASES
    • VALID_FIELDS
    • DEFAULT_FIELDS
    • SearchToken
      • fields
      • pattern
      • fields
      • pattern
      • _asdict()
      • _field_defaults
      • _fields
      • _make()
      • _replace()
    • SearchPattern
      • fields
      • raw
      • regex
      • fields
      • raw
      • regex
      • _asdict()
      • _field_defaults
      • _fields
      • _make()
      • _replace()
    • InvalidFieldError
    • normalize_fields()
    • _parse_field_prefix()
    • parse_query_terms()
    • _has_uppercase()
    • compile_search_patterns()
    • WorkspaceFields
      • name
      • path
      • session_name
      • windows
      • panes
      • name
      • path
      • session_name
      • windows
      • panes
    • WorkspaceSearchResult
      • filepath
      • source
      • fields
      • matches
      • filepath
      • source
      • fields
      • matches
    • extract_workspace_fields()
    • _get_field_values()
    • evaluate_match()
    • find_search_matches()
    • highlight_matches()
    • _output_search_results()
    • CLISearchNamespace
      • color
      • query_terms
      • field
      • ignore_case
      • smart_case
      • fixed_strings
      • word_regexp
      • invert_match
      • match_any
      • output_json
      • output_ndjson
      • print_help
    • create_search_subparser()
    • command_search()
  • tmuxp shell - tmuxp.cli.shell
    • CLIShellNamespace
      • color
      • session_name
      • socket_name
      • socket_path
      • colors
      • log_file
      • window_name
      • command
      • shell
      • use_pythonrc
      • use_vi_mode
    • create_shell_subparser()
    • command_shell()
  • CLI utilities - tmuxp.cli.utils
    • ColorMode
      • AUTO
      • ALWAYS
      • NEVER
    • Colors
      • SUCCESS
      • WARNING
      • ERROR
      • INFO
      • HEADING
      • HIGHLIGHT
      • MUTED
      • ERROR
      • HEADING
      • HIGHLIGHT
      • INFO
      • MUTED
      • SUCCESS
      • WARNING
      • _colorize()
      • _should_enable()
      • error()
      • format_kv()
      • format_label()
      • format_path()
      • format_rule()
      • format_separator()
      • format_tmux_option()
      • format_version()
      • heading()
      • highlight()
      • info()
      • muted()
      • success()
      • warning()
    • UnknownStyleColor
    • prompt()
    • prompt_bool()
    • prompt_choices()
    • prompt_yes_no()
    • strip_ansi()
    • style()
    • tmuxp_echo()
    • unstyle()
  • tmuxp.cli
    • create_parser()
    • CLINamespace
      • log_level
      • color
      • subparser_name
      • import_subparser_name
      • version
    • cli()
    • startup()
• Workspace
  • Builder - tmuxp.workspace.builder
    • _wait_for_pane_ready()
    • get_default_columns()
    • get_default_rows()
    • WorkspaceBuilder
      • session_name
      • server
      • on_progress
      • on_before_script
      • on_script_output
      • on_build_event
      • _session
      • session
      • session_exists()
      • build()
      • iter_create_windows()
      • iter_create_panes()
      • config_after_window()
      • find_current_attached_session()
      • first_window_pass()
  • Constants - tmuxp.workspace.constants
  • Finders - tmuxp.workspace.finders
    • LOCAL_WORKSPACE_FILES
    • is_workspace_file()
    • in_dir()
    • in_cwd()
    • find_local_workspace_files()
    • get_workspace_dir()
    • get_workspace_dir_candidates()
    • find_workspace_file()
    • is_pure_name()
  • Freezer - tmuxp.workspace.freezer
    • inline()
    • freeze()
  • Importers - tmuxp.workspace.importers
    • import_tmuxinator()
    • import_teamocil()
  • Loader - tmuxp.workspace.loader
    • expandshell()
    • expand_cmd()
    • expand()
    • trickle()
  • Validation - tmuxp.workspace.validation
    • SchemaValidationError
    • SessionNameMissingValidationError
    • WindowListMissingValidationError
    • WindowNameMissingValidationError
    • InvalidPluginsValidationError
    • validate_schema()
• Exceptions - tmuxp.exc
  • TmuxpException
  • WorkspaceError
  • SessionNotFound
  • WindowNotFound
  • PaneNotFound
  • EmptyWorkspaceException
  • SessionMissingWorkspaceException
  • ActiveSessionMissingWorkspaceException
  • TmuxpPluginException
  • BeforeLoadScriptNotExists
  • BeforeLoadScriptError
• Logging - tmuxp.log
  • TmuxpLoggerAdapter
    • process()
  • setup_logger()
  • set_style()
  • LogFormatter
    • template()
    • format()
  • debug_log_template()
  • DebugLogFormatter
    • template()
  • setup_log_file()
  • tmuxp_echo()
• Plugin - tmuxp.plugin
  • TMUX_MIN_VERSION
  • TMUX_MAX_VERSION
  • LIBTMUX_MIN_VERSION
  • LIBTMUX_MAX_VERSION
  • TMUXP_MIN_VERSION
  • TMUXP_MAX_VERSION
  • Config
    • plugin_name
    • tmux_min_version
    • tmux_max_version
    • tmux_version_incompatible
    • libtmux_min_version
    • libtmux_max_version
    • libtmux_version_incompatible
    • tmuxp_min_version
    • tmuxp_max_version
    • tmuxp_version_incompatible
  • validate_plugin_config()
  • setup_plugin_config()
  • TmuxpPlugin
    • _version_check()
    • _pass_version_check()
    • before_workspace_builder()
    • on_window_create()
    • after_window_finished()
    • before_script()
    • reattach()
• Shell - tmuxp.shell
  • has_ipython()
  • has_ptpython()
  • has_ptipython()
  • has_bpython()
  • detect_best_shell()
  • get_bpython()
  • get_ipython_arguments()
  • get_ipython()
  • get_ptpython()
  • get_ptipython()
  • get_launch_args()
  • get_code()
  • launch()
• Utilities - tmuxp.util
  • run_before_script()
  • oh_my_zsh_auto_title()
  • get_current_pane()
  • get_session()
  • get_window()
  • get_pane()
• Typings - tmuxp.types
  • StrPath