CLI

Warning

Be careful with these! Internal APIs are not covered by version policies. They can break or be removed between minor versions!

If you need an internal API stabilized please file an issue.

• tmuxp convert - tmuxp.cli.convert
  • create_convert_subparser()
  • ConvertUnknownFileType
    • __init__()
  • 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
    • __init__()
    • _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
    • __init__()
  • BuildTree
    • __init__()
    • on_event()
    • render()
    • _context()
    • format_template()
    • format_inline()
  • Spinner
    • __init__()
    • _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
    • __new__()
    • _asdict()
    • _field_defaults
    • _fields
    • _make()
    • _replace()
  • SearchPattern
    • fields
    • raw
    • regex
    • fields
    • raw
    • regex
    • __new__()
    • _asdict()
    • _field_defaults
    • _fields
    • _make()
    • _replace()
  • InvalidFieldError
    • __init__()
  • 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
    • __init__()
    • _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
    • __init__()
  • prompt()
  • prompt_bool()
  • prompt_choices()
  • prompt_yes_no()
  • strip_ansi()
  • style()
  • tmuxp_echo()
  • unstyle()

tmuxp.cli

CLI utilities for tmuxp.

tmuxp.cli.create_parser()

function

Create CLI argparse.ArgumentParser for tmuxp.

Return type:

ArgumentParser

class tmuxp.cli.CLINamespace

class

Bases: Namespace

Typed argparse.Namespace for tmuxp root-level CLI.

log_level: CLIVerbosity

attribute

color: CLIColorMode

attribute

subparser_name: CLISubparserName

attribute

import_subparser_name: CLIImportSubparserName | None

attribute

version: bool

attribute

tmuxp.cli.cli(_args=None)

function

Manage tmux sessions.

Pass the “–help” argument to any command to see detailed help. See detailed documentation and examples at: http://tmuxp.git-pull.com/

Parameters:

_args (list[str] | None)

Return type:

None

tmuxp.cli.startup(config_dir)

function

Initialize CLI.

Parameters:

• str (get_workspace_dir(): Config directory to search)

• config_dir (Path)

Return type:

None