tmux_interface is a library for communication with
TMUX via CLI written in
Rust programming language. The crate
documentation can be found on the
docs.rs page.
Add the new crate dependency in your Cargo.toml.
Using defaults (by default: default = ["tmux_2_8", "cmd_alias"] will be set)
[dependencies]
tmux_interface = "^0.1.0"
Using user specified tmux version (set custom tmux version feature, used for conditional compilaton):
There is an optional dependency parameter features in
Cargo.toml, to specify the compatible version of tmux. Because
different tmux versions may have incompatible CLI changes. Following
tmux versions are currently supported as library features:
tmux_0_8, tmux_0_9, tmux_1_0, tmux_1_1, tmux_1_2, tmux_1_3,
tmux_1_4, tmux_1_5, tmux_1_6, tmux_1_7, tmux_1_8, tmux_1_9,
tmux_1_9a, tmux_2_0, tmux_2_1, tmux_2_2, tmux_2_3, tmux_2_4,
tmux_2_5, tmux_2_6, tmux_2_7, tmux_2_8, tmux_2_9, tmux_2_9a,
tmux_3_0, tmux_3_0a, tmux_3_1, tmux_3_1a, tmux_3_1b,
tmux_3_1c, tmux_X_X
[dependencies]
tmux_interface = {
version = "^0.1.0",
features = ["tmux_2_6"]
default-features = false,
}
by default tmux_2_8 is used. It can be removed with
--no-default-features cargo command line option or with default-features
= false option in Cargo.toml in case of using different tmux version.
Using library from local repository:
[dependencies]
tmux_interface = {
version = "^0.1.0",
path = "../tmux-interface",
features = ["tmux_X_X"]
}
Using library from remote repository (for example using developing
branch):
[dependencies]
tmux_interface = {
git = "https://github.com/AntonGepting/tmux-interface-rs.git", branch = "dev",
features = ["tmux_X_X"]
}
Use library functions in your source file.
use methods of the parent structure (TmuxCommand):
```
use tmux_interface::TmuxCommand;
let tmux = TmuxCommand::new();
tmux.newsession() .detached() .sessionname("example1") .output() .unwrap(); tmux.hassession() .targetsession("example1") .output() .unwrap(); tmux.killsession() .targetsession("example_1") .output() .unwrap(); ```
use direct methods of the child structures (NewSession, HasSession,
KillSession, ...):
```
use tmux_interface::{HasSession, KillSession, NewSession};
NewSession::new() .detached() .sessionname("example2") .output() .unwrap(); HasSession::new() .targetsession("example2") .output() .unwrap(); KillSession::new() .targetsession("example2") .output() .unwrap(); ```
The library is still in experimental development stage (unstable). - many features are unimplemented or not well tested - some APIs/structures/names/... can be changed in the future - some design patterns of the library can be changed - almost all library documentation is missing at the moment - ...
The library was tested using GitHub Actions under following conditions:
OS:
Rust:
Tmux (covered tmux versions crate features):
tmux_X_Xtmux_3_1ctmux_3_1btmux_3_1atmux_3_1tmux_3_0atmux_3_0tmux_2_9atmux_2_9tmux_2_8tmux_2_7tmux_2_6tmux_2_5tmux_2_4tmux_2_3tmux_2_2tmux_2_1tmux_2_0tmux_1_9atmux_1_9tmux_1_8tmux_1_7tmux_1_6tmux_1_5tmux_1_4 - tmux compilation errortmux_1_3 - tmux compilation errortmux_1_2 - tmux compilation errortmux_1_1 - tmux compilation errortmux_1_0 - tmux compilation errortmux_0_9 - tmux compilation errortmux_0_8 - tmux compilation errortmux_interface library is licensed under the MIT license. Please read the
license file in the repository for more information.