├── LICENSE ├── README.md ├── scripts └── tmux-ssh-split.sh ├── ssh-split.tmux ├── tmux-ssh-split.gif └── tmux.sample.conf /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 🎛️ TMUX SSH Split 2 | 3 | [![](./tmux-ssh-split.gif)](https://asciinema.org/a/335250) 4 | 5 | This TMUX plugin is a modern iteration of the concept 6 | [sshh](https://github.com/yudai/sshh) 7 | introduced. 8 | 9 | It enables seamless SSH 10 | splits. If you're in an SSH session in the current pane and press the designated 11 | key combination, the pane will split, and the newly created pane will host an 12 | SSH session connected to the host you were previously on. If there's no active 13 | SSH session, a regular split will occur. 14 | 15 | 💡 NOTE: mosh works too to some extent (experimental) 16 | 17 | ## 📥 Installation 18 | 19 | You can install this plugin using [TPM](https://github.com/tmux-plugins/tpm): 20 | 21 | ``` 22 | set -g @plugin 'pschmitt/tmux-ssh-split' 23 | ``` 24 | 25 | ## 🛠️ Configuration 26 | 27 | To use this plugin, you need to set at least one of the `ssh-split-h-key` 28 | or `ssh-split-v-key` options. These keys (`PREFIX + key`) will be bound to 29 | horizontal and vertical splits, respectively. 30 | 31 | ## ⚙️ Options 32 | 33 | | Option | Description | Default Value | 34 | | --- | --- | --- | 35 | | `@ssh-split-h-key` | Key to bind for horizontal splits (prefixed) | *none* | 36 | | `@ssh-split-v-key` | Key to bind for vertical splits (prefixed) | *none* | 37 | | `@ssh-split-w-key` | Key to bind for new windows (prefixed) | *none* | 38 | | `@ssh-split-r-key` | Key to bind for respawn pane (prefixed) | *none* | 39 | | `@ssh-split-keep-cwd` | Determines whether the starting directory of the new pane should be the same as the current pane. This is similar to executing `tmux split -c "#{pane_current_path}"`. | `false` | 40 | | `@ssh-split-keep-remote-cwd` | Similar to the above, but for remote (SSH) splits. Note that remote path detection requires an [OSC7 prompt](https://wezfurlong.org/wezterm/shell-integration.html#osc-7-escape-sequence-to-set-the-working-directory) and falls back to PS1 parsing, so it won't work if your prompt doesn't contain the current path. This works best with `@ssh-split-strip-cmd=true` | `false` | 41 | | `@ssh-split-fail` | Determines whether to do nothing if the current pane isn't running SSH. By default, a normal split will occur. | `false` | 42 | | `@ssh-split-no-env` | If set to true, this will not set `TMUX_SSH_SPLIT=1` in splits (see tips and tricks section) | `false` | 43 | | `@ssh-split-no-shell` | If set to true, this will prevent a shell session from spawning after the SSH session, causing the pane to exit when the SSH session ends. | `false` | 44 | | `@ssh-split-strip-cmd` | If set to true, the SSH command executed in the new pane will be stripped of the remote command portion. For example, if you're running `ssh HOST COMMAND` in a pane and you split it, tmux-ssh-split will create a new pane with a start command of `ssh HOST`. | `false` | 45 | | `@ssh-split-verbose` | Displays a message before the SSH command is spawned with the command being executed | `false` | 46 | | `@ssh-split-debug` | Debug mode. Redirects the script output to `/tmp/tmux-ssh-split.log` (or `$TMPDIR/tmux-ssh-split.log` if `TMPDIR` is defined). | `false` | 47 | 48 | ### 💡 Example config 49 | 50 | ``` 51 | set-option -g @ssh-split-keep-cwd "true" 52 | set-option -g @ssh-split-keep-remote-cwd "true" 53 | set-option -g @ssh-split-fail "false" 54 | set-option -g @ssh-split-no-env "false" 55 | set-option -g @ssh-split-no-shell "false" 56 | set-option -g @ssh-split-strip-cmd "true" 57 | set-option -g @ssh-split-verbose "true" 58 | set-option -g @ssh-split-debug "false" 59 | set-option -g @ssh-split-h-key "|" 60 | set-option -g @ssh-split-v-key "S" 61 | set-option -g @ssh-split-w-key "C" 62 | set-option -g @ssh-split-r-key "R" 63 | 64 | set -g @plugin 'pschmitt/tmux-ssh-split' 65 | ``` 66 | 67 | ## 🔌 Compatibility with Other Plugins 68 | 69 | Some plugins may attempt to bind the same keys as tmux-ssh-split. For instance, 70 | [tmux-pain-control](https://github.com/tmux-plugins/tmux-pain-control) is one 71 | such plugin. With the example configuration provided, both tmux-ssh-split 72 | and tmux-pain-control would try to bind the `|` key. The plugin loaded last 73 | will prevail. 74 | 75 | ### ✅ Solution 76 | 77 | I've sent 78 | [a PR to fix this](https://github.com/tmux-plugins/tmux-pain-control/pull/33) 79 | upstream. In the meantime you can 80 | [use my fork](https://github.com/pschmitt/tmux-pain-control/). 81 | 82 | To make the **forked** `tmux-pain-control` not bind the `|` key you can set 83 | the following: 84 | 85 | ``` 86 | set -g @disabled_keys "|" 87 | ``` 88 | 89 | ## 🎩 Tips and Tricks 90 | 91 | If you want to determine whether a command has been spawned via tmux-ssh-split 92 | in a local or remote split, you can check for the `TMUX_SSH_SPLIT` environment 93 | variable. It should be set to `1` for all splits. If `TMUX_SSH_SPLIT` is not set 94 | on remote splits, ensure that `TMUX_SSH_SPLIT` is listed in the `AcceptEnv` 95 | property in your sshd config. For example: 96 | 97 | ``` 98 | AcceptEnv LANG LC_* TMUX_SSH_SPLIT 99 | ``` 100 | 101 | 🤚 If you want to disable this feature add the following to your TMUX config: 102 | 103 | ``` 104 | set-option -g @ssh-split-no-env "true" 105 | ``` 106 | 107 | ## 📜 License 108 | 109 | This project is open source and available under the terms of the 110 | [GNU General Public License v3.0](./LICENSE) 111 | -------------------------------------------------------------------------------- /scripts/tmux-ssh-split.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | usage() { 4 | echo "Usage: $(basename "$0") ARGS" 5 | echo 6 | echo "Arguments:" 7 | echo " -v|-h Vertical or horizontal split" 8 | echo " --fail Error out if there is no SSH session in the current pane" 9 | echo " --verbose Display a message when spawning a new SSH session/pane" 10 | echo " --no-shell Don't spawn a shell after the SSH command" 11 | echo " -c DIR Set start directory for pane" 12 | } 13 | 14 | is_linux() { 15 | local os 16 | os=$(uname -s) 17 | [[ "${os,,}" == "linux" ]] 18 | } 19 | 20 | is_macos() { 21 | local os 22 | os=$(uname -s) 23 | [[ "${os,,}" == "darwin" ]] 24 | } 25 | 26 | get_current_pane_info() { 27 | tmux display -p '#{pane_id} #{pane_pid}' 28 | } 29 | 30 | get_current_pane_id() { 31 | get_current_pane_info | awk '{ print $1 }' 32 | } 33 | 34 | get_pane_pid_from_pane_id() { 35 | tmux list-panes -F "#{pane_id} #{pane_pid}" | awk "/^$1 / { print \$2}" 36 | } 37 | 38 | __is_ssh_option() { 39 | # This returns a shift index 40 | # 0: Don't shift (this is either the hostname, or part of the command) 41 | # 1: shift 1 (option-less flags) 42 | # 2: shift 2 (flags with mandatory options) 43 | case "$1" in 44 | autossh|ssh|mosh) 45 | echo "1" 46 | ;; 47 | # Option-less flags (can be combined - hence the "*") 48 | -4*|-6*|-A*|-a*|-C*|-f*|-G*|-g*|-K*|-k*|-M*|-N*|-n*|-q*|-s*|-T*|-t*|-v*|-V*|-X*|-x*|-Y*|-y*|--) 49 | echo "1" 50 | ;; 51 | # Flags with options 52 | -B|-b|-c|-D|-E|-e|-F|-I|-i|-J|-L|-l|-m|-O|-o|-p|-Q|-R|-S|-W|-w) 53 | echo "2" 54 | ;; 55 | # Unknown flags 56 | -*) 57 | echo "Unknown flag: $1" >&2 58 | return 9 59 | ;; 60 | # Command 61 | *) 62 | return 1 63 | ;; 64 | esac 65 | } 66 | 67 | is_ssh_command() { 68 | grep -qE '^[^ ]*(ssh|autossh) ' <<< "$1" 69 | } 70 | 71 | is_mosh_command() { 72 | grep -qE '^[^ ]*(mosh|mosh-client) ' <<< "$1" 73 | } 74 | 75 | is_ssh_or_mosh_command() { 76 | # Filter out invalid commands 77 | if ! command -v -- "$(cut -d' ' -f1 <<< "$1")" &>/dev/null 78 | then 79 | return 1 80 | fi 81 | 82 | # Filter out git/sftp commands 83 | if ! grep -vqE "git-(upload|receive|send)-pack|sftp" <<< "$1" 84 | then 85 | return 1 86 | fi 87 | 88 | is_ssh_command "$1" || is_mosh_command "$1" 89 | } 90 | 91 | strip_command() { 92 | local pid cmd 93 | read -r pid cmd <<< "$*" 94 | 95 | # Return immediately if not processing an SSH command 96 | is_ssh_command "$cmd" || return 1 97 | 98 | if is_linux && [[ -r /proc/${pid}/cmdline ]] 99 | then 100 | # cmdline is null-separated 101 | mapfile -d '' -t cmd < "/proc/${pid}/cmdline" 102 | fi 103 | 104 | set -- "${cmd[@]}" 105 | 106 | local og_args=("$@") 107 | local res=() 108 | local shift_num 109 | local host_index=0 110 | 111 | while [[ -n "$*" ]] 112 | do 113 | if ! shift_num=$(__is_ssh_option "$1") 114 | then 115 | # Stop processing args if we hit a command 116 | break 117 | fi 118 | 119 | # Advance host index (we didn't process that arg yet) 120 | host_index=$(( host_index + shift_num )) 121 | 122 | [[ -n "$shift_num" ]] || continue 123 | shift "$shift_num" 124 | done 125 | 126 | local ssh_hostname="${og_args[${host_index}]}" 127 | 128 | if [[ -n "$1" ]] 129 | then 130 | # Shift host 131 | shift 132 | fi 133 | 134 | # Save remaining args 135 | local post_host_args=("$@") 136 | local post_index=0 137 | res=("${og_args[@]::${host_index}}") 138 | 139 | # Process args that follow the hostname 140 | while [[ -n "$*" ]] 141 | do 142 | if ! shift_num=$(__is_ssh_option "$1") 143 | then 144 | # Stop processing args if we hit a command 145 | break 146 | fi 147 | 148 | [[ -n "$shift_num" ]] || continue 149 | # Add SSH option (+ arg) to the end of the res array. This will end up 150 | # *before* the hostname in what's printed to stdout at the end. 151 | res+=("${post_host_args[@]:${post_index}:${shift_num}}") 152 | post_index=$(( post_index + shift_num )) 153 | shift "$shift_num" 154 | done 155 | 156 | # Echo result back and append host 157 | if [[ -n "${res[*]}" ]] 158 | then 159 | printf '%q ' "${res[@]}" "$ssh_hostname" 160 | # Alternative (bashism) 161 | # echo "${res[*]@Q} $ssh_hostname" 162 | fi 163 | } 164 | 165 | inject_ssh_env() { 166 | local cmd=("$@") 167 | 168 | if is_ssh_command "${cmd[*]}" 169 | then 170 | # shellcheck disable=SC2001 171 | sed 's#ssh#ssh -o SendEnv=TMUX_SSH_SPLIT#' <<< "${cmd[*]}" 172 | return $? 173 | fi 174 | 175 | if is_mosh_command "${cmd[*]}" 176 | then 177 | # shellcheck disable=SC2001 178 | sed "s#mosh#mosh --ssh='ssh -o SendEnv=TMUX_SSH_SPLIT'#" <<< "${cmd[*]}" 179 | return $? 180 | fi 181 | 182 | return 1 183 | } 184 | 185 | inject_remote_cwd() { 186 | local ssh_command="$1" 187 | local ssh_cwd 188 | 189 | if ! ssh_cwd="$(get_remote_path)" || [[ -z "$ssh_cwd" ]] 190 | then 191 | echo "Failed to extract remote cwd from PS1" >&2 192 | echo "$ssh_command" 193 | return 0 194 | fi 195 | 196 | local remote_command=( 197 | "cd \"${ssh_cwd}\" 2>/dev/null" 198 | ) 199 | 200 | local parent_cwd="${ssh_cwd%/*}" 201 | if [[ -n "$parent_cwd" ]] 202 | then 203 | remote_command+=("||") 204 | remote_command+=("cd \"${parent_cwd}\"") 205 | fi 206 | 207 | remote_command+=( 208 | ";" 209 | "exec \${SHELL:-/usr/bin/env sh} -l" 210 | ) 211 | 212 | if is_mosh_command "$ssh_command" 213 | then 214 | ssh_command="$ssh_command -- sh -c '${remote_command[*]}'" 215 | else 216 | ssh_command="$ssh_command -t '${remote_command[*]}'" 217 | fi 218 | 219 | echo "$ssh_command" 220 | } 221 | 222 | extract_ssh_host() { 223 | # Re-set the args in case the whole command is passed through "$1" 224 | if [[ "$#" -eq 1 ]] 225 | then 226 | # shellcheck disable=2086 227 | set -- $1 228 | fi 229 | shift # shift the command (ssh) 230 | 231 | local shift_num 232 | 233 | while [[ -n "$*" ]] 234 | do 235 | if ! shift_num=$(__is_ssh_option "$1") 236 | then 237 | break 238 | fi 239 | 240 | [[ -n "$shift_num" ]] || continue 241 | shift "$shift_num" 242 | done 243 | 244 | if [[ -n "$1" ]] 245 | then 246 | echo "$1" 247 | return 248 | fi 249 | 250 | return 1 251 | } 252 | 253 | # FIXME This might not be the most reliable host extraction 254 | extract_mosh_host() { 255 | sed -nr 's/.*mosh-client -# ([^\s+])\s+.*/\1/p' <<< "$1" 256 | } 257 | 258 | get_child_cmds() { 259 | local ppid="$1" 260 | 261 | # macOS 262 | if is_macos 263 | then 264 | # Untested, contributed by @liuruibin 265 | # https://github.com/pschmitt/tmux-ssh-split/pull/6 266 | # NOTE Shouldn't we use "ps a" here? 267 | # shellcheck disable=SC2009 268 | ps -o ppid=,pid=,command= | \ 269 | awk '/^\s*'"${ppid}"'\s+/ { $1=""; print $0 }' 270 | return "$?" 271 | fi 272 | 273 | # Linux 274 | ps -o pid=,command= -g "$ppid" 275 | } 276 | 277 | # $1 is optional, disable 2120 278 | # shellcheck disable=2120 279 | get_ssh_command() { 280 | local pane_id 281 | local pane_pid 282 | 283 | pane_id="${1:-$(get_current_pane_id)}" 284 | pane_pid="$(get_pane_pid_from_pane_id "$pane_id")" 285 | 286 | if [[ -z "$pane_pid" ]] 287 | then 288 | echo "Could not determine pane PID" >&2 289 | return 3 290 | fi 291 | 292 | local host 293 | # For debugging you can set the pane PID manually here 294 | # to list tmux pane pids run: $ tmux list-panes -F '#{pane_pid}' 295 | # pane_pid="1722114" 296 | local child_pid child_cmd 297 | get_child_cmds "$pane_pid" | while read -r child_pid child_cmd 298 | do 299 | # Skip non-ssh commands 300 | is_ssh_or_mosh_command "$child_cmd" || continue 301 | 302 | # Filter out "ssh -W" 303 | grep -qE "ssh.*\s+-W\s+" <<< "$child_cmd" && continue 304 | 305 | # mosh is a special case, the child command will look like this: 306 | # mosh-client -# hostname | 192.168.69.42 60001 307 | if is_mosh_command "$child_cmd" 308 | then 309 | host="$(extract_mosh_host "$child_cmd")" 310 | 311 | if [[ -z "$host" ]] 312 | then 313 | echo "Could not extract hostname from mosh command: $child_cmd" >&2 314 | continue 315 | fi 316 | 317 | child_cmd="LC_ALL=${LC_ALL:-en_US.UTF-8} mosh $host" 318 | fi 319 | 320 | echo "$child_cmd" 321 | return 0 322 | done 323 | 324 | return 1 325 | } 326 | 327 | get_remote_cwd() { 328 | # PROBABLY WON'T EVER WORK 329 | # To get the current paths on the remote server one can run the following: 330 | # 1. In the SSH session, grab the TTY: 331 | # $ echo ${SSH_TTY#/dev/} 332 | # 2. To get the CWD: 333 | # $ readlink -f /proc/$(ps -o pid= -t $SSH_TTY_FROM_ABOVE | head -1)/cwd 334 | 335 | # Alternative: 336 | # for pid in $(pgrep -P "$(pgrep -a sshd | grep -- "${SSH_TTY##/dev/}" | awk '{ print $1; exit }')"); do readlink -f /proc/$pid/cwd; done 337 | 338 | echo "Not implemented yet!" >&2 339 | return 1 340 | } 341 | 342 | guess_remote_shell() { 343 | if [[ "$#" -eq 1 ]] 344 | then 345 | # shellcheck disable=2086 346 | set -- $1 347 | fi 348 | 349 | is_ssh_or_mosh_command "$@" && shift 350 | ssh "$@" 'echo $SHELL' 351 | } 352 | 353 | # Below requires vte shell integration aka osc7 354 | get_pane_path_osc7() { 355 | # pane_path returns "file://myhost/home/pschmitt" where myhost is the 356 | # hostname and the rest the path 357 | local data 358 | data="$(tmux display -pF '#{pane_path}')" 359 | local local_host="${HOSTNAME:-$(hostname)}" 360 | 361 | local host path 362 | read -r host path <<< "$(sed -nr 's#file://([^/]*)(/.*)#\1 \2#p' <<< "$data")" 363 | 364 | # Only return the path if the host is not the local one 365 | # This is to avoid returning the local path when the remote shell does 366 | # not support OSC7 367 | if [[ "$host" == "$local_host" ]] 368 | then 369 | return 1 370 | fi 371 | 372 | echo "$path" 373 | } 374 | 375 | get_remote_path() { 376 | local remote_path 377 | remote_path="$(get_pane_path_osc7)" 378 | 379 | if [[ -n "$remote_path" ]] 380 | then 381 | echo "$remote_path" 382 | return 0 383 | fi 384 | 385 | # Fall back to ps1 extraction 386 | echo "Failed to determine remote path using OSC7, falling back to PS1 extraction" >&2 387 | extract_path_from_ps1 388 | } 389 | 390 | extract_path_from_ps1() { 391 | local line 392 | line=$(tmux capture-pane -p | sed '/^$/d' | tail -1) 393 | 394 | # Search for zsh hash dirs (eg: ~zsh/bin) 395 | local match 396 | if match=$(grep -m 1 -oP '~[^\s]+' <<< "$line") 397 | then 398 | # Remove trailing '$' or '#' (bash prompt char) and ']' 399 | # shellcheck disable=2001 400 | match=$(sed 's|[]$#/]*$||' <<< "${match}") 401 | 402 | # shellcheck disable=2088 403 | if [[ "$match" == '~' ]] 404 | then 405 | echo "Current dir seems to be '~', ignoring since it probably the default anyway" >&2 406 | return 0 407 | fi 408 | 409 | # Replace ~ with $HOME to avoid "No such file or directory" errors. 410 | # https://github.com/pschmitt/tmux-ssh-split/issues/16 411 | echo -n "${match/\~/\$HOME}" 412 | return 0 413 | fi 414 | 415 | # Search for paths 416 | if match=$(grep -m 1 -o '/[^ ]*' <<< "$line") 417 | then 418 | # 1. Remove trailing '$', '#', ']', and ' '(space) 419 | # https://github.com/pschmitt/tmux-ssh-split/issues/17 420 | # 2. Remove quotes (eg: ' or ") 421 | sed -r -e 's/[]$# ]+$//' -e "s/['\"]//g" <<< "${match}" 422 | return 423 | fi 424 | 425 | echo "Failed to extract path from PS1" >&2 426 | return 1 427 | } 428 | 429 | if [[ "${BASH_SOURCE[0]}" == "${0}" ]] 430 | then 431 | while [[ -n "$*" ]] 432 | do 433 | case "$1" in 434 | help|h|--help) 435 | usage 436 | exit 0 437 | ;; 438 | --debug|-D) 439 | DEBUG=1 440 | shift 441 | ;; 442 | -h|-v) 443 | SPLIT_ARGS+=("$1") 444 | shift 445 | ;; 446 | -w|--window) 447 | WINDOW=1 448 | shift 449 | ;; 450 | -r|--respawn) 451 | RESPAWN=1 452 | shift 453 | ;; 454 | -c) 455 | if [[ -z "$2" ]] 456 | then 457 | echo "Missing start directory" >&2 458 | usage >&2 459 | exit 2 460 | fi 461 | # Only set start dir if it still exists 462 | if [[ -d "$2" ]] 463 | then 464 | SPLIT_ARGS+=(-c "$2") 465 | fi 466 | shift 2 467 | ;; 468 | --keep-remote-cwd) 469 | KEEP_REMOTE_CWD=1 470 | shift 471 | ;; 472 | --fail) 473 | FAIL=1 474 | shift 475 | ;; 476 | --no-shell|--noshell|-n) 477 | NO_SHELL=1 478 | shift 479 | ;; 480 | --no-env|--noenv) 481 | NO_ENV=1 482 | shift 483 | ;; 484 | --verbose|-V) 485 | VERBOSE=1 486 | shift 487 | ;; 488 | --strip-cmd|--strip|-s) 489 | STRIP_CMD=1 490 | shift 491 | ;; 492 | -*) 493 | usage >&2 494 | exit 2 495 | ;; 496 | esac 497 | done 498 | 499 | if [[ -n "$DEBUG" ]] 500 | then 501 | set -x 502 | 503 | # Write debug output to file if not running in a terminal 504 | if [[ ! -t 0 ]] 505 | then 506 | exec >> "${TMPDIR:-/tmp}/tmux-ssh-split.log" 507 | exec 2>&1 508 | fi 509 | fi 510 | 511 | if [[ -z "$NO_ENV" ]] 512 | then 513 | SPLIT_ARGS+=(-e "TMUX_SSH_SPLIT=1") 514 | fi 515 | 516 | SSH_COMMAND="$(get_ssh_command)" 517 | 518 | if [[ -z "$SSH_COMMAND" ]] 519 | then 520 | if [[ -n "$FAIL" ]] 521 | then 522 | tmux display "Error: current pane seems to not be running SSH..." 523 | echo "Could not determine SSH command" >&2 524 | exit 1 525 | fi 526 | 527 | if [[ -n "$WINDOW" ]] 528 | then 529 | # remove -h and -v from split args 530 | SPLIT_ARGS=("${SPLIT_ARGS[@]/-h}") 531 | SPLIT_ARGS=("${SPLIT_ARGS[@]/-v}") 532 | 533 | tmux new-window "${SPLIT_ARGS[@]}" 534 | elif [[ -n "$RESPAWN" ]] 535 | then 536 | tmux respawn-pane -k "${SPLIT_ARGS[@]}" 537 | else 538 | tmux split "${SPLIT_ARGS[@]}" 539 | fi 540 | 541 | exit 0 542 | fi 543 | 544 | if [[ -n "$STRIP_CMD" ]] 545 | then 546 | SSH_COMMAND_STRIPPED="$(strip_command "$SSH_COMMAND")" 547 | 548 | if [[ -z "$SSH_COMMAND_STRIPPED" ]] 549 | then 550 | echo "Could not strip command: $SSH_COMMAND" >&2 551 | else 552 | SSH_COMMAND="$SSH_COMMAND_STRIPPED" 553 | fi 554 | fi 555 | 556 | # Experimental 557 | if [[ -n "$KEEP_REMOTE_CWD" ]] 558 | then 559 | SSH_COMMAND="$(inject_remote_cwd "$SSH_COMMAND")" 560 | fi 561 | 562 | if [[ -z "$NO_ENV" ]] 563 | then 564 | # Inject -o SendEnv TMUX_SSH_SPLIT=1 into the SSH command 565 | SSH_COMMAND="$(inject_ssh_env "$SSH_COMMAND")" 566 | fi 567 | 568 | START_CMD="$SSH_COMMAND" 569 | 570 | if [[ -z "$NO_SHELL" ]] 571 | then 572 | DEFAULT_SHELL="$(tmux show-option -gqv "default-shell")" 573 | 574 | if [[ -z "$DEFAULT_SHELL" ]] 575 | then 576 | # Fall back to sh 577 | DEFAULT_SHELL="$(command -v sh)" 578 | fi 579 | 580 | # Open default shell on exit (SSH timeout, Ctrl-C etc.) 581 | START_CMD="trap '${DEFAULT_SHELL}' EXIT INT; ${START_CMD}" 582 | fi 583 | 584 | if [[ -n "$VERBOSE" ]] 585 | then 586 | # Escape single quotes in the command 587 | SSH_COMMAND_ESCAPED=${SSH_COMMAND//\'/\'\\\'\'} 588 | START_CMD="echo -e '🧙👉 Running \e[34;1m\$ ${SSH_COMMAND_ESCAPED}\e[0m'; ${START_CMD}" 589 | fi 590 | 591 | if [[ -n "$WINDOW" ]] 592 | then 593 | # remove -h and -v from split args 594 | SPLIT_ARGS=("${SPLIT_ARGS[@]/-h}") 595 | SPLIT_ARGS=("${SPLIT_ARGS[@]/-v}") 596 | 597 | tmux new-window "${SPLIT_ARGS[@]}" "$START_CMD" 598 | elif [[ -n "$RESPAWN" ]] 599 | then 600 | tmux respawn-pane -k "${SPLIT_ARGS[@]}" "$START_CMD" 601 | else 602 | tmux split "${SPLIT_ARGS[@]}" "$START_CMD" 603 | fi 604 | fi 605 | 606 | # vim: set ft=bash et ts=2 sw=2 : 607 | -------------------------------------------------------------------------------- /ssh-split.tmux: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | get_tmux_option() { 4 | local option="$1" 5 | local default_value="$2" 6 | local raw_value 7 | 8 | raw_value=$(tmux show-option -gqv "$option") 9 | 10 | echo "${raw_value:-$default_value}" 11 | } 12 | 13 | main() { 14 | local -a extra_args 15 | local current_dir 16 | local fail 17 | local hkey 18 | local noenv 19 | local noshell 20 | local script_path 21 | local verbose 22 | local debug 23 | local vkey 24 | local wkey 25 | local keep_cwd 26 | local keep_remote_cwd 27 | local rkey 28 | 29 | debug="$(get_tmux_option @ssh-split-debug)" 30 | verbose="$(get_tmux_option @ssh-split-verbose)" 31 | fail="$(get_tmux_option @ssh-split-fail)" 32 | keep_cwd="$(get_tmux_option @ssh-split-keep-cwd)" 33 | keep_remote_cwd="$(get_tmux_option @ssh-split-keep-remote-cwd)" 34 | noenv="$(get_tmux_option @ssh-split-no-env)" 35 | noshell="$(get_tmux_option @ssh-split-no-shell)" 36 | stripcmd="$(get_tmux_option @ssh-split-strip-cmd)" 37 | hkey="$(get_tmux_option @ssh-split-h-key)" 38 | vkey="$(get_tmux_option @ssh-split-v-key)" 39 | wkey="$(get_tmux_option @ssh-split-w-key)" 40 | rkey="$(get_tmux_option @ssh-split-r-key)" 41 | 42 | case "$keep_cwd" in 43 | true|1|yes) 44 | # Double quote path since it may contain spaces. 45 | # Especially when the current dir gets deleted, tmux then 46 | # appends " (removed)" 47 | extra_args+=(-c "'#{pane_current_path}'") 48 | ;; 49 | esac 50 | 51 | case "$keep_remote_cwd" in 52 | true|1|yes) 53 | extra_args+=(--keep-remote-cwd) 54 | ;; 55 | esac 56 | 57 | case "$fail" in 58 | true|1|yes) 59 | extra_args+=(--fail) 60 | ;; 61 | esac 62 | 63 | case "$noenv" in 64 | true|1|yes) 65 | extra_args+=(--no-env) 66 | ;; 67 | esac 68 | 69 | case "$noshell" in 70 | true|1|yes) 71 | extra_args+=(--no-shell) 72 | ;; 73 | esac 74 | 75 | case "$stripcmd" in 76 | true|1|yes) 77 | extra_args+=(--strip-cmd) 78 | ;; 79 | esac 80 | 81 | case "$verbose" in 82 | true|1|yes) 83 | extra_args+=(--verbose) 84 | ;; 85 | esac 86 | 87 | case "$debug" in 88 | true|1|yes) 89 | extra_args+=(--debug) 90 | ;; 91 | esac 92 | 93 | current_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" 94 | script_path="${current_dir}/scripts/tmux-ssh-split.sh" 95 | 96 | if [[ -n "$hkey" ]] 97 | then 98 | tmux unbind "$hkey" 99 | tmux bind-key "$hkey" run "${script_path} ${extra_args[*]} -h" 100 | fi 101 | 102 | if [[ -n "$vkey" ]] 103 | then 104 | tmux unbind "$vkey" 105 | tmux bind-key "$vkey" run "${script_path} ${extra_args[*]} -v" 106 | fi 107 | 108 | if [[ -n "$wkey" ]] 109 | then 110 | tmux unbind "$wkey" 111 | tmux bind-key "$wkey" run "${script_path} ${extra_args[*]} --window" 112 | fi 113 | 114 | if [[ -n "$rkey" ]] 115 | then 116 | tmux unbind "$rkey" 117 | tmux bind-key "$rkey" run "${script_path} ${extra_args[*]} --respawn" 118 | fi 119 | } 120 | 121 | if [[ "${BASH_SOURCE[0]}" == "${0}" ]] 122 | then 123 | main 124 | fi 125 | 126 | # vim: set ft=bash et ts=2 sw=2 : 127 | -------------------------------------------------------------------------------- /tmux-ssh-split.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/pschmitt/tmux-ssh-split/07b9e46c18b68dcf805fdcc1f8d8e7c215b998f9/tmux-ssh-split.gif -------------------------------------------------------------------------------- /tmux.sample.conf: -------------------------------------------------------------------------------- 1 | # tpm 2 | 3 | set-option -g @ssh-split-fail "false" 4 | set-option -g @ssh-split-no-shell "false" 5 | set-option -g @ssh-split-verbose "true" 6 | set-option -g @ssh-split-h-key "|" 7 | set-option -g @ssh-split-v-key "S" 8 | 9 | set -g @plugin 'pschmitt/tmux-ssh-split' 10 | --------------------------------------------------------------------------------