https://github.com/jeroenjanssens/tmuxr

Manage tmux from R
https://github.com/jeroenjanssens/tmuxr

automation command-line r rstats terminal tmux

Last synced: 11 days ago
JSON representation

Manage tmux from R

• Host: GitHub
• URL: https://github.com/jeroenjanssens/tmuxr
• Owner: jeroenjanssens
• License: other
• Created: 2017-07-05T08:44:41.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-26T12:14:38.000Z (6 months ago)
• Last Synced: 2024-10-13T02:14:25.785Z (25 days ago)
• Topics: automation, command-line, r, rstats, terminal, tmux
• Language: R
• Homepage: https://jeroenjanssens.github.io/tmuxr/
• Size: 5.23 MB
• Stars: 54
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - jeroenjanssens/tmuxr - Manage tmux from R (R)

README

        
---

output:

  github_document:

    html_preview: false

---

```{r, echo = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "README-"

)

```

# tmuxr 

[![R-CMD-check](https://github.com/jeroenjanssens/tmuxr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jeroenjanssens/tmuxr/actions/workflows/R-CMD-check.yaml)

[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-green.svg)](https://www.tidyverse.org/lifecycle/#stable)

## Overview

`tmuxr` is an R package that allows you to manage [tmux](https://github.com/tmux/tmux/wiki) and interact with the processes it runs. It features a pipeable API with which you can create, control, and capture tmux sessions, windows, and panes. 

## Demonstration

The recording below demonstrates various capabilities of `tmuxr` such as: running processes, sending keys, splitting windows, and capturing panes. Note that normally, managing tmux and the processes it runs is done in a detached mode, so you wouldn't see anything, but the result would be the same.

[![tmuxr demonstration](man/figures/demo.png)](https://asciinema.org/a/325231)

Have a look at [the function reference](https://jeroenjanssens.github.io/tmuxr/reference/) to learn more about what `tmuxr` has to offer.

## Installation

`tmuxr` can be installed from this repository using `remotes`:

```{r, eval=FALSE}

# install.packages("remotes")

remotes::install_github("jeroenjanssens/tmuxr")

```

  

## Compatibility

We regularly test `tmuxr` on Ubuntu with tmux versions 2.1 through 3.4 and on macOS with the latest version of tmux provided by Homebrew. `tmuxr` might work on Windows using Cygwin or WSL, but we haven't tested this.

## License

The `tmuxr` package is licensed under the MIT License.