TMUXINATOR(1)

🎀 TMUXINATOR 🎀

okay so bestie, welcome to tmuxinator(1) — the manual page for a lil tool called tmuxinator that lets you manage complex tmux sessions easily. like, actually easily. no cap. 💖

---

✨ NAME ✨

tmuxinator — manage complex tmux sessions easily 🌸

---

🦋 USAGE 🦋

tmuxinator [COMMANDS] [OPTION]

that's it. that's the whole shape of it. you give it a command, you optionally give it an option, and it goes off and does main character things with your tmux sessions. 💅

---

👑 COMMANDS 👑

here's the whole menu, gorgeous. every single one. no skipping. 🍓

💫 commands

Lists commands available in tmuxinator

💫 completions [arg1 arg2]

Used for shell completion

💫 copy [EXISTING] [NEW]

Copy an existing project to a new project and open it in your editor ✨

💫 debug [PROJECT] [ARGS]

Output the shell commands that are generated by tmuxinator — like, it literally shows you the receipts 🔍

💫 delete [PROJECT1] [PROJECT2] ...

Deletes given project

ok so heads up: you can pass one project, or a whole list of them, separated by spaces. it deletes given project, plural energy. 🫶

💫 doctor

Look for problems in your configuration — your config's annual checkup, bestie 🩺

💫 help [COMMAND]

Describe available commands or one specific command

💫 implode

Deletes all tmuxinator projects

WARNING, HELLO: this one deletes ALL of your tmuxinator projects. not one. not two. all. it's giving nuclear. 💀 please be seated and calm before you type this one.

💫 list

Lists all tmuxinator projects

💫 local

Start a tmux session using ./.tmuxinator.yml — so it grabs the config right there in your current directory, cute and local, obsessed. 🎀

💫 new [PROJECT] [SESSION]

Create a new project file and open it in your editor

💫 start [PROJECT] [ARGS]

Start a tmux session using a project's name (with an optional [ALIAS] for project reuse) or a path to a project config file (via the -p flag)

💫 stop [PROJECT]

Stop a tmux session using a project's tmuxinator config

💫 version

Display installed tmuxinator version

---

🌈 AUTHOR 🌈

Copyright (c) 2010-2019 Allen Bargi, Christopher Chow. See /usr/share/doc/tmuxinator/copyright for further details.

shoutout to the icons who built this. 👑💜

---

🌸 NOTE 🌸

This manual page was written by Youhei SASAKI <uwabami@gfd-dennou.org>, for the Debian project (but may ber used others).

ngl the "ber" is their typo, not mine, i'm just being faithful to the source material ok 😭 iconic either way, we don't edit legends.

---

that's the whole page, bestie. go forth and session-ify. 🧚✨

this was tmuxinator 3.1.0, from December 2019, and yes i know that's basically ancient history in internet years — still slaps tho 💖💅