even after setting -x and -y with new-session, select-layout won't take effect. However, it is necessary in 2.6 to get pane creation in detached mode to work.

the only way found for tmux select-layout to take effect and prior behavior to have viewed the window you are running "select-layout" for in the client.

a solution has been devised to connect the client to the session, then run select-layout on each window in the session. However, it's still not enough to load the session, it seems the window must be selected by the client at least once for the select-layout to take effect.

so a hook against the session is created for the session that selects each window, runs select layout ~~at the -t target for the window id~~. and after that, the hook is neatly unset when that's finished.

I'd like to switch the license to something even more permissive than BSD 3-clause (MIT).

Sorry for causing the ping, but wanted to get it out of the way.

If you're ok with it, please reply with a note that you agree for your code contribution(s) to tmuxp to be released under the MIT license.

• [x] @ikirudennis
• [x] @ThiefMaster
• [x] @sebastianst
• [x] @kmactavish
• [x] @thomasballinger
• [x] @madprog
• [x] @tasdomas
• [x] @myw
• [x] @fpietka
• [ ] @roxit
• [x] @jorise
• [x] @apieum (by thumbs up)
• [x] @marbu
• [x] @rafi
• [x] @mexicarne
• [x] @stemid (by thumbs up)
• [x] @abeyer
• [x] @ohardy
• [x] @gtback
• [x] @techtonik
• [x] @raine
• [x] @yegortimoshenko
• [ ] @cryptojuice
• [x] @yvaucher
• [x] @estin
• [x] @achals
• [x] @sehe
• [x] @Omeryl
• [x] @joelwallis
• [x] @Ilyes512

I am getting the following error in all configurations. (I tried the config from the readme as well)

Traceback (most recent call last):
  File "/home/vn-ki/.local/bin/tmuxp", line 11, in <module>
    load_entry_point('tmuxp==1.4.0', 'console_scripts', 'tmuxp')()
  File "/usr/lib/python3.6/site-packages/click/core.py", line 722, in __call__
    return self.main(*args, **kwargs)
  File "/usr/lib/python3.6/site-packages/click/core.py", line 697, in main
    rv = self.invoke(ctx)
  File "/usr/lib/python3.6/site-packages/click/core.py", line 1066, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3.6/site-packages/click/core.py", line 895, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/lib/python3.6/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "/usr/lib/python3.6/site-packages/click/decorators.py", line 17, in new_func
    return f(get_current_context(), *args, **kwargs)
  File "/home/vn-ki/.local/lib/python3.6/site-packages/tmuxp/cli.py", line 602, in command_load
    load_workspace(config[-1], **tmux_options)
  File "/home/vn-ki/.local/lib/python3.6/site-packages/tmuxp/cli.py", line 328, in load_workspace
    builder.build()
  File "/home/vn-ki/.local/lib/python3.6/site-packages/tmuxp/workspacebuilder.py", line 141, in build
    session_name=self.sconf['session_name']
  File "/home/vn-ki/.local/lib/python3.6/site-packages/libtmux/server.py", line 511, in new_session
    session = Session(server=self, **session)
  File "/home/vn-ki/.local/lib/python3.6/site-packages/libtmux/session.py", line 42, in __init__
    raise ValueError('Session requires a `session_id`')
ValueError: Session requires a `session_id`

Hi,

I just installed tmuxp using pip3 install tmuxp. It believed it installed fine because if I type just tmuxp, it shows the help.

I have a tmux session named main. But when I typed tmuxp freeze main, I got this backtrace:

> tmuxp freeze main
Traceback (most recent call last):
  File "/home/kmodi/stowed/bin/tmuxp", line 11, in <module>
    load_entry_point('tmuxp==1.2.8', 'console_scripts', 'tmuxp')()
  File "/home/kmodi/stow/pkgs/python/3.6.1/lib/python3.6/site-packages/click/core.py", line 722, in __call__
    return self.main(*args, **kwargs)
  File "/home/kmodi/stow/pkgs/python/3.6.1/lib/python3.6/site-packages/click/core.py", line 697, in main
    rv = self.invoke(ctx)
  File "/home/kmodi/stow/pkgs/python/3.6.1/lib/python3.6/site-packages/click/core.py", line 1066, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/kmodi/stow/pkgs/python/3.6.1/lib/python3.6/site-packages/click/core.py", line 895, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/kmodi/stow/pkgs/python/3.6.1/lib/python3.6/site-packages/click/core.py", line 535, in invoke
    return callback(*args, **kwargs)
  File "/home/kmodi/stow/pkgs/python/3.6.1/lib/python3.6/site-packages/tmuxp/cli.py", line 387, in command_freeze
    sconf = freeze(session)
  File "/home/kmodi/stow/pkgs/python/3.6.1/lib/python3.6/site-packages/tmuxp/workspacebuilder.py", line 324, in freeze
    'options': w.show_window_options(),
  File "/home/kmodi/stow/pkgs/python/3.6.1/lib/python3.6/site-packages/libtmux/window.py", line 195, in show_window_options
    window_options = dict(cmd)
ValueError: dictionary update sequence element #2 has length 4; 2 is required

Python version: 3.6.1 OS: RHEL 6.6

During packaging tmuxp and after building tmuxp, I run the tests using python3 setup.py test.

However, test_workspacebuilder.py does never return (hangs forever) and I have to kill the build and build without tests (not good):

running test
Searching for pytest==3.4.2
Reading https://pypi.python.org/simple/pytest/
Downloading https://files.pythonhosted.org/packages/f1/5c/411ceafef3b5e5486d16f174db18dc26f49e7704dbf59ef488e95db47339/pytest-3.4.2-py2.py3-none-any.whl#sha256=062027955bccbc04d2fcd5d79690947e018ba31abe4c90b2c6721abec734261b
Best match: pytest 3.4.2
Processing pytest-3.4.2-py2.py3-none-any.whl
Installing pytest-3.4.2-py2.py3-none-any.whl to /build/tmuxp/src/tmuxp-1.4.0/.eggs
writing requirements to /build/tmuxp/src/tmuxp-1.4.0/.eggs/pytest-3.4.2-py3.6.egg/EGG-INFO/requires.txt

Installed /build/tmuxp/src/tmuxp-1.4.0/.eggs/pytest-3.4.2-py3.6.egg
running egg_info
writing tmuxp.egg-info/PKG-INFO
writing dependency_links to tmuxp.egg-info/dependency_links.txt
writing entry points to tmuxp.egg-info/entry_points.txt
writing requirements to tmuxp.egg-info/requires.txt
writing top-level names to tmuxp.egg-info/top_level.txt
reading manifest file 'tmuxp.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
writing manifest file 'tmuxp.egg-info/SOURCES.txt'
running build_ext
============================= test session starts ==============================
platform linux -- Python 3.6.5, pytest-3.4.2, py-1.5.3, pluggy-0.6.0
rootdir: /build/tmuxp/src/tmuxp-1.4.0, inifile: setup.cfg
plugins: rerunfailures-4.0
collected 94 items

tests/test_cli.py .......................................                [  0%]
tests/test_config.py ...............                                     [  0%]
tests/test_config_teamocil.py ........                                   [  0%]
tests/test_config_tmuxinator.py ...                                      [  0%]
tests/test_util.py .....                                                 [  0%]
tests/test_workspacebuilder.py ...s...........

Do I have to run the tests somehow differently? Am I missing something?

This is supposed to fix #139.

I added a shell-configuration to the pane layer. This way you can specify for every pane what shell/application is supposed to be started. I added an example to the documentation to drive the point home why it makes sense.

I wasn't really able to understand how to add the test cases to the test environment. I hope someone can help with this. The example should hopefully already contain most edge cases in any case.

The more complicated part was to make sure that the shell command for the first pane gets respected by the window creation, as the shell for the first pane has to be handed over to the create-window-command.

I have a simple config with three windows. I have set focus: true for the first window to show upon loading a new session. Instead of the first, second window opens up.

session.yaml

session_name: daily
windows:
  - window_name: default
    focus: true
    layout: main-horizontal
    options:
      main-pane-height: 4
    panes:
    - shell_command:
      - watch acpi --thermal
    - shell_command:
      - task
  - window_name: projects
    start_directory: ~/projects
    panes:
    - shell_command:
      - ls
  - window_name: prog
    layout: main-horizontal
    panes:
    - shell_command:
      - py3
    - shell_command:
      - node

What is wrong with my configuration?

Version information:

tmuxp 1.3.5 tmux 2.6 Debian Testing

The Pipfile lists many version pinned requirements. IMHO requirements should ideally never be version pinned (only if really really required). Please remove the version pinning, where not needed! It's hard to do proper packaging with this (especially for distributions, that follow upstream closely, such as Arch Linux).

For the following session file (~/.tmuxp/mail.yaml):

session_name: mail
windows:
- window_name: foo
  panes:
    - mutt
- window_name: bar
  panes:
    - mutt -F ~/.muttrc.bar

I'm getting

~ ❯❯❯ tmuxp load mail
[Loading] /home/francisco/.tmuxp/mail.yaml
ERROR:libtmux.session:list index out of range
Traceback (most recent call last):
  File "/usr/lib/python3.5/site-packages/libtmux/common.py", line 238, in __getattr__
    return self._info[self.formatter_prefix + key]
TypeError: 'NoneType' object is not subscriptable

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/bin/tmuxp", line 9, in <module>
    load_entry_point('tmuxp==1.2.0', 'console_scripts', 'tmuxp')()
  File "/usr/lib/python3.5/site-packages/click/core.py", line 716, in __call__
    return self.main(*args, **kwargs)
  File "/usr/lib/python3.5/site-packages/click/core.py", line 696, in main
    rv = self.invoke(ctx)
  File "/usr/lib/python3.5/site-packages/click/core.py", line 1060, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3.5/site-packages/click/core.py", line 889, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/lib/python3.5/site-packages/click/core.py", line 534, in invoke
    return callback(*args, **kwargs)
  File "/usr/lib/python3.5/site-packages/click/decorators.py", line 17, in new_func
    return f(get_current_context(), *args, **kwargs)
  File "/usr/lib/python3.5/site-packages/tmuxp/cli.py", line 484, in command_load
    load_workspace(config[-1], **tmux_options)
  File "/usr/lib/python3.5/site-packages/tmuxp/cli.py", line 260, in load_workspace
    builder.build()
  File "/usr/lib/python3.5/site-packages/tmuxp/workspacebuilder.py", line 144, in build
    assert(self.sconf['session_name'] == session.name)
  File "/usr/lib/python3.5/site-packages/libtmux/common.py", line 241, in __getattr__
    (self.__class__, key))
AttributeError: <class 'libtmux.session.Session'> has no property name

I'm on ArchLinux using the AUR package: https://aur.archlinux.org/packages/tmuxp.

This fixes #832.

Open question: what's the intended/desired fallback behavior?

1. (Currently implemented) If a pane doesn't have a environment configuration it uses the environment configuration of the window. This means that in order to change one environment variable (compared to the window) the full environment configuration needs to be duplicated. This also makes it possible to unset some variable if needed (compared to 2.) by skipping it int the configuration.
2. The environment of a pane is ChainMapped with the one of the window (and possibly the session?) which means that the final environment contains all variables from both pane and window with the pane value taking precedence over the one from the window. This would avoid the possible duplication of 1. but makes it harder to unset an variable (in case an empty value doesn't suffice).
3. Something else? Proposals welcome.

Tests are currently failing as the check for old tmux versions isn't implemented yet.

With this simple configuration now the main window is always with width 2. It doesn't matter whether I set main-pane-width: 160 or not, it's always loaded in a strip of just 2 columns.

session_name: foo
windows:
- layout: main-vertical
  panes:
  - blank
  - blank

I'm using the package from AUR.

Issue is present both in vertical and horizontal layouts.

Step 1: Provide a summary of your problem

When packaging 1.22.0, the test test_window_shell fails.

Step 2: Provide tmuxp details

n/a

Step 3: Describe the problem:

Steps to reproduce:

Same as in my other tickets

Observed Results:

=================================== FAILURES ===================================
______________________________ test_window_shell _______________________________

session = Session($1 libtmux_a2zoq8m_)

    def test_window_shell(session):
        workspace = ConfigReader._from_file(
            test_utils.get_workspace_file("workspace/builder/window_shell.yaml")
        )
        workspace = loader.expand(workspace)

        builder = WorkspaceBuilder(sconf=workspace)

>       for w, wconf in builder.iter_create_windows(session):

tests/workspace/test_builder.py:319:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
test_dir/usr/lib/python3.10/site-packages/tmuxp/workspace/builder.py:376: in iter_create_windows
    w = session.new_window(
/usr/lib/python3.10/site-packages/libtmux/session.py:552: in new_window
    return Window.from_window_id(
/usr/lib/python3.10/site-packages/libtmux/window.py:92: in from_window_id
    window = fetch_obj(
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

server = Server(socket_name=libtmux_testeupg4wcy), obj_key = 'window_id'
obj_id = '@2', list_cmd = 'list-windows', list_extra_args = ('-a',)

    def fetch_obj(
        server: "Server",
        obj_key: str,
        obj_id: str,
        list_cmd: "ListCmd" = "list-panes",
        list_extra_args: "ListExtraArgs" = None,
    ) -> OutputRaw:
        obj_formatters_filtered = fetch_objs(
            server=server, list_cmd=list_cmd, list_extra_args=list_extra_args
        )

        obj = None
        for _obj in obj_formatters_filtered:
            if _obj.get(obj_key) == obj_id:
                obj = _obj

>       assert obj is not None
E       assert None is not None

/usr/lib/python3.10/site-packages/libtmux/neo.py:242: AssertionError
=========================== short test summary info ============================
FAILED tests/workspace/test_builder.py::test_window_shell - assert None is no...

tmuxp-1.22.0-1-x86_64-check.log

Expected Results:

All tests pass

Relevant Code:

n/a

Step 1: Provide a summary of your problem

Panes name doesn't work, all have the same name: zsh

OS: Linux Mint 21.1 (Ubuntu 22.04 based) Shell: zsh. I use powerlevel10k for terminal customization, the theme is based on the zsh shell.

.tmux.conf

unbind C-b
set-option -g prefix C-a
set-option -g allow-rename off
set -g default-terminal "screen-256color"
set -g pane-border-format "#{pane_index} #{pane_title}"
set -g pane-border-status bottom
set -g status-left-length 85
set-window-option -g window-status-current-style bg=yellow
set -g mouse on
# List of TMUX Plugins
set -g @plugin 'tmux-plugins/tpm'
set -g @plugin 'tmux-plugins/tmux-sensible'
set -g @plugin 'tmux-plugins/tmux-resurrect'
set -g @plugin 'tmux-plugins/tmux-continuum'
# Initialize TMUX plugin manager (keep this line at the very bottom of tmux.conf)
run '~/.tmux/plugins/tpm/tpm'

Step 2: Provide tmuxp details

tmuxp debug-info

-------------------------
environment:
	dist: Linux-5.15.0-56-generic-x86_64-with-glibc2.35
	arch: x86_64
	uname: Linux; marius; 5.15.0-56-generic
	version: #62-Ubuntu SMP Tue Nov 22 19:54:14 UTC 2022
-------------------------
python version: 3.10.6 (main, Nov 14 2022, 16:10:14) [GCC 11.3.0]
system PATH: /home/marius/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/usr/local/go/bin:/usr/local/bin:/home/marius/
tmux version: 3.2
libtmux version: 0.10.1
tmuxp version: 1.9.2
tmux path: /usr/bin/tmux
tmuxp path: /usr/lib/python3/dist-packages/tmuxp/__init__.py
shell: /usr/bin/zsh
-------------------------
tmux sessions:
	0: 1 windows (created Thu Dec 22 03:55:48 2022) (attached)
	4-pane-split: 1 windows (created Thu Dec 22 03:57:58 2022)
	alt-pane-split: 1 windows (created Thu Dec 22 03:56:54 2022)

tmux windows:
	0: zsh* (1 panes) [190x43] [layout b8bd,190x43,0,0,0] @0 (active)

tmux panes:
	0: [190x42] [history 287/50000, 131286 bytes] %0 (active)

tmux global options:
	@continuum-save-last-timestamp 1671675049
	@plugin tmux-plugins/tmux-continuum
	@resurrect-restore-script-path /home/marius/.tmux/plugins/tmux-resurrect/scripts/restore.sh
	@resurrect-save-script-path /home/marius/.tmux/plugins/tmux-resurrect/scripts/save.sh
	@resurrect-strategy-irb default_strategy
	@resurrect-strategy-mosh-client default_strategy
	activity-action other
	assume-paste-time 1
	base-index 0
	bell-action any
	default-command ''
	default-shell /usr/bin/zsh
	default-size 80x24
	destroy-unattached off
	detach-on-destroy on
	display-panes-active-colour red
	display-panes-colour blue
	display-panes-time 1000
	display-time 4000
	history-limit 50000
	key-table root
	lock-after-time 0
	lock-command "lock -np"
	message-command-style bg=black,fg=yellow
	message-style bg=yellow,fg=black
	mouse off
	prefix C-a
	prefix2 None
	renumber-windows off
	repeat-time 500
	set-titles off
	set-titles-string "#S:#I:#W - \"#T\" #{session_alerts}"
	silence-action other
	status on
	status-bg default
	status-fg default
	status-format[0] "#[align=left range=left #{status-left-style}]#[push-default]#{T;=/#{status-left-length}:status-left}#[pop-default]#[norange default]#[list=on align=#{status-justify}]#[list=left-marker]<#[list=right-marker]>#[list=on]#{W:#[range=window|#{window_index} #{window-status-style}#{?#{&&:#{window_last_flag},#{!=:#{window-status-last-style},default}}, #{window-status-last-style},}#{?#{&&:#{window_bell_flag},#{!=:#{window-status-bell-style},default}}, #{window-status-bell-style},#{?#{&&:#{||:#{window_activity_flag},#{window_silence_flag}},#{!=:#{window-status-activity-style},default}}, #{window-status-activity-style},}}]#[push-default]#{T:window-status-format}#[pop-default]#[norange default]#{?window_end_flag,,#{window-status-separator}},#[range=window|#{window_index} list=focus #{?#{!=:#{window-status-current-style},default},#{window-status-current-style},#{window-status-style}}#{?#{&&:#{window_last_flag},#{!=:#{window-status-last-style},default}}, #{window-status-last-style},}#{?#{&&:#{window_bell_flag},#{!=:#{window-status-bell-style},default}}, #{window-status-bell-style},#{?#{&&:#{||:#{window_activity_flag},#{window_silence_flag}},#{!=:#{window-status-activity-style},default}}, #{window-status-activity-style},}}]#[push-default]#{T:window-status-current-format}#[pop-default]#[norange list=on default]#{?window_end_flag,,#{window-status-separator}}}#[nolist align=right range=right #{status-right-style}]#[push-default]#{T;=/#{status-right-length}:status-right}#[pop-default]#[norange default]"
	status-format[1] "#[align=centre]#{P:#{?pane_active,#[reverse],}#{pane_index}[#{pane_width}x#{pane_height}]#[default] }"
	status-interval 5
	status-justify left
	status-keys emacs
	status-left "[#{session_name}] "
	status-left-length 85
	status-left-style default
	status-position bottom
	status-right "#(/home/marius/.tmux/plugins/tmux-continuum/scripts/continuum_save.sh)#{?window_bigger,[#{window_offset_x}#,#{window_offset_y}] ,}\"#{=21:pane_title}\" %H:%M %d-%b-%y"
	status-right-length 40
	status-right-style default
	status-style bg=green,fg=black
	update-environment[0] DISPLAY
	update-environment[1] KRB5CCNAME
	update-environment[2] SSH_ASKPASS
	update-environment[3] SSH_AUTH_SOCK
	update-environment[4] SSH_AGENT_PID
	update-environment[5] SSH_CONNECTION
	update-environment[6] WINDOWID
	update-environment[7] XAUTHORITY
	visual-activity off
	visual-bell off
	visual-silence off
	word-separators " "

tmux window options:
	aggressive-resize on
	allow-rename off
	alternate-screen on
	automatic-rename on
	automatic-rename-format "#{?pane_in_mode,[tmux],#{pane_current_command}}#{?pane_dead,[dead],}"
	clock-mode-colour blue
	clock-mode-style 24
	copy-mode-match-style bg=cyan,fg=black
	copy-mode-current-match-style bg=magenta,fg=black
	copy-mode-mark-style bg=red,fg=black
	main-pane-height 24
	main-pane-width 80
	mode-keys emacs
	mode-style bg=yellow,fg=black
	monitor-activity off
	monitor-bell on
	monitor-silence 0
	other-pane-height 0
	other-pane-width 0
	pane-active-border-style "#{?pane_in_mode,fg=yellow,#{?synchronize-panes,fg=red,fg=green}}"
	pane-base-index 0
	pane-border-format "#{pane_index} #{pane_title}"
	pane-border-lines single
	pane-border-status bottom
	pane-border-style default
	remain-on-exit off
	synchronize-panes off
	window-active-style default
	window-size latest
	window-style default
	window-status-activity-style reverse
	window-status-bell-style reverse
	window-status-current-format "#I:#W#{?window_flags,#{window_flags}, }"
	window-status-current-style bg=yellow
	window-status-format "#I:#W#{?window_flags,#{window_flags}, }"
	window-status-last-style default
	window-status-separator " "
	window-status-style default
	wrap-search on
	xterm-keys on

Step 3: Describe the problem:

Steps to reproduce:

1. tmuxp load mysession (cretated folder .tmuxp in home directory that hold all the .yml files)
2. My .yml file (mysession) is the default example from tmuxp

Expected Results:

The pane must respect the name declared in the .yml file

I want to run a tmux command after the session creation. Using the following command in my tmux.conf:

set-hook -g after-new-session 'display-popup -w 80% -h 60% neofetch'

causes the following exception:

Traceback (most recent call last):
  File "/usr/bin/tmuxp", line 8, in <module>
    sys.exit(cli.cli())
  File "/usr/lib/python3.10/site-packages/tmuxp/cli/__init__.py", line 134, in cli
    command_load(
  File "/usr/lib/python3.10/site-packages/tmuxp/cli/load.py", line 655, in command_load
    load_workspace(
  File "/usr/lib/python3.10/site-packages/tmuxp/cli/load.py", line 446, in load_workspace
    _load_attached(builder, detached)
  File "/usr/lib/python3.10/site-packages/tmuxp/cli/load.py", line 183, in _load_attached
    builder.build()
  File "/usr/lib/python3.10/site-packages/tmuxp/workspace/builder.py", line 217, in build
    session = self.server.new_session(
  File "/usr/lib/python3.10/site-packages/libtmux/server.py", line 605, in new_session
    raise exc.LibTmuxException(proc.stderr)
libtmux.exc.LibTmuxException: ['no current client']

Is there any way to do this using tmuxp?

in re: debugging cases like #364

Requirements / blockers

Requires improvements for libtmux and its subprocess calls

Details

1. There's no way to assert the message is raised - except maybe checking pytest's caplog with logging turned up to the max.
2. We need better introspection of events at the libtmux level:
   • Being able to trace where in the config / workspacebuilder libtmux methods are being run
     • and the subprocess calls to tmux(1) within those

tmux uses the default login shell and thus tests might fail if this is not bash (or something compatible). Explicitly stating which shell to use circumvents issues arising from accidentally using another shell.