Skip to content

Commit 5e48597

Browse files
committed
Update help info for CLI commands
1 parent e6bf90d commit 5e48597

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

tmuxp/cli.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -747,12 +747,12 @@ def get_parser():
747747
subparsers = parser.add_subparsers(
748748
title='commands',
749749
description='valid commands',
750-
help='additional help'
751750
)
752751

753752
kill_session = subparsers.add_parser(
754753
'kill-session',
755-
parents=[server_parser]
754+
parents=[server_parser],
755+
help='Kill tmux session by name.'
756756
)
757757
kill_session.set_defaults(callback=command_kill_session)
758758

@@ -766,7 +766,10 @@ def get_parser():
766766

767767
attach_session = subparsers.add_parser(
768768
'attach-session',
769-
parents=[server_parser, client_parser]
769+
parents=[server_parser, client_parser],
770+
help='If run from outside tmux, create a new client in the current '
771+
'terminal and attach it. If used from inside, switch the current '
772+
'client.'
770773
)
771774
attach_session.set_defaults(callback=command_attach_session)
772775

@@ -779,7 +782,8 @@ def get_parser():
779782

780783
freeze = subparsers.add_parser(
781784
'freeze',
782-
parents=[server_parser]
785+
parents=[server_parser],
786+
help='Create a snapshot of a tmux session and save it to JSON or YAML.'
783787
)
784788
freeze.set_defaults(callback=command_freeze)
785789

@@ -792,7 +796,9 @@ def get_parser():
792796

793797
load = subparsers.add_parser(
794798
'load',
795-
parents=[server_parser, client_parser]
799+
parents=[server_parser, client_parser],
800+
help='Load a configuration from file. Attach the session. If session '
801+
'already exists, offer to attach instead.'
796802
)
797803

798804
loadgroup = load.add_mutually_exclusive_group(required=True)
@@ -843,7 +849,7 @@ def get_parser():
843849

844850
importparser = subparsers.add_parser(
845851
'import',
846-
help='Import configurations from teamocil and tmuxinator'
852+
help='Import configurations from teamocil and tmuxinator.'
847853
)
848854
importsubparser = importparser.add_subparsers(
849855
title='commands',

0 commit comments

Comments
 (0)