tmux_interface

Description

tmux_interface is a rust language library for communication with TMUX via CLI.

Usage

1. Add a dependency in your Cargo.toml

   [dependencies]
   tmux_interface = "^0.1.0"
   

2. Add extern crate and use in your source file

   extern crate tmux_interface;
   

3. Use it's functions

   let tmux = TmuxInterface::new();
   let new_session = NewSession {
       detached: Some(true),
       session_name: Some("session_name"),
       ..Default::default()
   };
   tmux.new_session(&new_session).unwrap();
   tmux.kill_session(None, None, Some("session_name")).unwrap();
   

Misc

• Versions below 0.1.0 are first public releases, mostly for development and testing purposes. Do not use them in your Projects.

• Used in mosaic - tmux manager

• Tested on: tmux 2.8

Directory Structure

• src/ - crate sources

  1. Common:

     • tmux_interface.rs - common functions
     • tmux_interface_error.rs - error propagating functions
     • lib.rs - main library file

  2. TMUX functions (structure like in TMUX manual):

     • clients_and_sessions.rs
     • windows_and_panes.rs
     • key_bindings.rs
     • options.rs
     • hooks.rs
     • global_and_session_environment.rs
     • status_line.rs
     • buffers.rs
     • miscellaneous.rs

  3. Unit tests for functions and their parts:

     • tmux_interface_tests.rs

  4. Parsing functions:

     • sessions.rs - parse a session list
     • session.rs - parse a session
     • windows.rs - parse a windows list
     • window.rs - parse a window
     • panes.rs - parse a panes list
     • pane.rs - parse a pane
     • tmux_option.rs - parse an option

  5. Unit tests for parsing functions:

     • sessions_tests.rs
     • session_tests.rs
     • windows_tests.rs
     • window_tests.rs
     • panes_tests.rs
     • pane_tests.rs
     • tmux_option_tests.rs

• tests/ - crate integration tests (multiple functions):

  • tmux_interface.rs
  • tmux_mock.sh - bash script can be used instead of tmux binary, for simple logging (sniffing) intercommmunication between library functions and tmux
  • tmux_test.sh - bash script for output testing of tmux functions

• README.md - common information (this file)

• LICENSE.md - license text

• ROADMAP.md - future goals, wishlist, ideas

• CHANGELOG.md - version history

• Cargo.toml - crate configuration (File Format)

• .travis.yml - travis CI configuration (File Format)

• .editorconfig - consisten conding style configuration (File Format)

License

tmux_interface is licensed under the MIT license. Please read the license file in this repository for more information.