tmux-python / tmux-python/tmuxp

`tmuxp run-script`

Open
#772 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
4.6k
Forks
248
Avg merge
2h 13m
Merged PRs (30d)
1

Description

Rather than having a tmuxp load <config> a user can run tmuxp run <script-path>, it can do any combination of:

  • Build / detect / modify existing server, session, window and panes
  • Attach session or keep it in the background

See also:

https://github.com/vcs-python/vcspull/issues/335



def run(server: 'libtmux.Server`):
    session.new_session(session_name="my session")
    # custom setup
    session.attach_session()

Todo

  • A way to pass arguments / add_arguments()
    • Just use argparse? Make sure tmuxp run-script [script_file_path] --help works

Inspiration

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the tmuxp CLI entry point for load and review the libtmux.Server example, then compare the django-extensions runscript and argparse references. Done means a script path can be run to create or modify tmux resources, attach or remain in the background, and accept arguments with --help support.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.