{"id":25856940,"url":"https://github.com/m42e/nvimux","last_synced_at":"2026-06-09T12:31:12.894Z","repository":{"id":195692893,"uuid":"691995188","full_name":"m42e/nvimux","owner":"m42e","description":"vimux for neovim: Easily interact with tmux, for neovim, written in lua","archived":false,"fork":false,"pushed_at":"2023-10-05T08:39:45.000Z","size":26,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-09T07:57:49.864Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/m42e.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-09-15T10:29:24.000Z","updated_at":"2023-10-03T18:40:39.000Z","dependencies_parsed_at":"2023-09-19T08:39:55.943Z","dependency_job_id":null,"html_url":"https://github.com/m42e/nvimux","commit_stats":null,"previous_names":["m42e/nvimux"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/m42e/nvimux","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m42e%2Fnvimux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m42e%2Fnvimux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m42e%2Fnvimux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m42e%2Fnvimux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m42e","download_url":"https://codeload.github.com/m42e/nvimux/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m42e%2Fnvimux/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34107865,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-01T18:29:28.119Z","updated_at":"2026-06-09T12:31:12.868Z","avatar_url":"https://github.com/m42e.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# nvimux: like vimux but in lua for neovim\n\nNvimux was inspired by Vimux, which itself was inspired by tslime.vim.\nIt let's you interact with a tmux pane in an easy way.\nYou can simply run commands in there, send text to it, and as an\nadvantage over vimux load the history into a buffer, or the quickfix list.\n\n## Installation\n\nLazy.nvim:\n\n```lua\n{\n    \"m42e/nvimux\",\n    config=true\n}\n```\n\n## Configuration\n```lua\n  {\n    -- the height/width of the pane if it has to be created\n    height = '20%',\n    -- the orientation, either `h`orizontal or `v`ertical\n    orientation = \"v\",\n    -- Use a pane/window near the current one, if existing\n    use_nearest = true,\n    -- Reset equences based on the mode of the tmux pane\n    reset_mode_sequence = {\n      -- copy-mode could be left with `q`\n      [\"copy-mode\"] = \"q\",\n    },\n    -- The string to ask the user for a command to enter\n    prompt_string = \"Command? \",\n    -- Run in `pane` or `window`\n    runner_type = \"pane\",\n    -- Specify a specific pane/window name\n    runner_name = \"\",\n    -- Tmux command or full path to be used\n    tmux_command = \"tmux\",\n    -- additional arguments for the pane if created\n    open_extra_args = {},\n    -- Expand commands, entered into the prompt\n    expand_command = false,\n    -- Close the pane on exit\n    close_on_exit = false,\n    -- Provide shell command completion for prompt\n    command_shell = true,\n    -- Find a runner by a specific query, see tmux for possible filters\n    runner_query = {},\n    -- Key combinations used\n    keys = {\n      -- for clearing the screen\n      clear_screen = \"C-l\",\n      -- for scrolling up in copy-mode\n      scroll_up = \"C-u\",\n      -- for scrolling down in copy-mode\n      scroll_down = \"C-d\",\n      -- for resetting the commandline (delete current line)\n      reset_cmdline = \"C-u\",\n      -- to interrupt runninng command\n      interrupt = \"C-c\",\n      -- to confirm command\n      confirm_command = \"Enter\",\n    },\n  }\n```\n\n## Commands\n* [NvimuxRunCommand](#nvimuxruncommand)\n* [NvimuxSendText](#nvimuxsendtext)\n* [NvimuxSendKeys](#nvimuxsendkeys)\n* [NvimuxRunLastCommand](#nvimuxrunlastcommand)\n* [NvimuxOpenRunner](#nvimuxopenrunner)\n* [NvimuxCloseRunner](#nvimuxcloserunner)\n* [NvimuxZoomRunner](#nvimuxzoomrunner)\n* [NvimuxInspectRunner](#nvimuxinspectrunner)\n* [NvimuxScrollUpInspect](#nvimuxscrollupinspect)\n* [NvimuxScrollDownInspect](#nvimuxscrolldowninspect)\n* [NvimuxInterruptRunner](#nvimuxinterruptrunner)\n* [NvimuxPromptCommand](#nvimuxpromptcommand)\n* [NvimuxClearTerminalScreen](#nvimuxclearterminalscreen)\n* [NvimuxClearRunnerHistory](#nvimuxclearrunnerhistory)\n* [NvimuxTogglePane](#nvimuxtogglepane)\n* [NvimuxLog](#nvimuxlog)\n* [NvimuxLoadPane](#nvimuxloadpane)\n* [NvimuxQuickFix](#nvimuxquickfix)\n\n### NvimuxRunCommand\n\nRun a shell command in an extra pane.\n\n```vim\n    \" Run the current file with rspec\n    vim.keymap.set(\"n\", \"\u003cleader\u003evl\", require(\"nvimux\").run(\"clear; rspec \" . bufname(\"%\")), {})\n```\n\nLua API:\n```lua\n    require(\"nvimux\").run(command, autoreturn)\n```\n\n\n### NvimuxSendText\n\nSends text, as it is to the runner pane if there is one opened.\nInteracts with any program or shell waiting for input.\n\n```vim\n    \" Send the content of the \" register to the pane\n    local get_reg = function()\n      return vim.api.nvim_exec(\\[\\[echo getreg('\\]\\]..char..\\[\\[')\\]\\], true):gsub(\"[\\n\\r]\", \"^J\")\n    end\n    vim.keymap.set(\"n\", \"\u003cleader\u003eP\", require(\"nvimux\").send_keys(get_reg(\"\\\"\")), {})\n```\n\nLua API:\n```lua\n    require(\"nvimux\").send_text(your_string)\n```\n\n\n### NvimuxSendKeys\n\nSends key or keycombination (such ash C-u for Ctrl+u) to the runner pane if there is one opened.\nInteracts with any program or shell waiting for input.\n\nLua API:\n```lua\n    require(\"nvimux\").send_keys(key)\n```\n\n\n### NvimuxRunLastCommand\n\nReruns the last command run with either |NvimuxRunCommand| or |NvimuxPromptCommand|\n\nLua API:\n```lua\n    require(\"nvimux\").run_last()\n```\n\n\n### NvimuxOpenRunner\n\nNo description available\n\nLua API:\n```lua\n    require(\"nvimux\").open()\n```\n\n\n### NvimuxCloseRunner\n\nCloses the open runner, if there is one.\n\nLua API:\n```lua\n    require(\"nvimux\").close_runner()\n```\n\n\n### NvimuxZoomRunner\n\nZooms the runner, like the \"\u003cbindkey\u003e z\", which you can then use to unzoom.\n\nLua API:\n```lua\n    require(\"nvimux\").zoom_runner()\n```\n\n\n### NvimuxInspectRunner\n\nPuts the runnter into inspect/copy-mode, to scroll around\n\nLua API:\n```lua\n    require(\"nvimux\").inspect_runner()\n```\n\n\n### NvimuxScrollUpInspect\n\nPuts the runnter into inspect/copy-mode if needed and scroll up.\n\nLua API:\n```lua\n    require(\"nvimux\").inspect_scroll_up()\n```\n\n\n### NvimuxScrollDownInspect\n\nPuts the runnter into inspect/copy-mode if needed and scroll down.\n\nLua API:\n```lua\n    require(\"nvimux\").inspect_scroll_down()\n```\n\n\n### NvimuxInterruptRunner\n\nSends Ctrl-c, to the running process in the open pane.\n\nLua API:\n```lua\n    require(\"nvimux\").interrupt_runner()\n```\n\n\n### NvimuxPromptCommand\n\nOpens a prompt to be filled, allows to add some prefix command.\n\nLua API:\n```lua\n    require(\"nvimux\").prompt_command(\u003cprefix\u003e)\n```\n\n\n### NvimuxClearTerminalScreen\n\nClears the screen in the pane.\n\nLua API:\n```lua\n    require(\"nvimux\").clear_terminal_screen()\n```\n\n\n### NvimuxClearRunnerHistory\n\nClears the tmux history in the pane.\n\nLua API:\n```lua\n    require(\"nvimux\").clear_history()\n```\n\n\n### NvimuxTogglePane\n\nMakes a pane a window and vice versa, will not change the settings.\n\nLua API:\n```lua\n    require(\"nvimux\").toggle()\n```\n\n\n### NvimuxLog\n\nPrint the stored log entries of nvimux.\n\n\n### NvimuxLoadPane\n\nThis will load all the history of a pane up to the numer of lines, or all if not specified, into a buffer.\n\nLua API:\n```lua\n    require(\"nvimux\").toggle()\n```\n\n\n### NvimuxQuickFix\n\nThis will load all the history of a pane up to the numer of lines, or all if not specified into the quickfix list\nThe first argument is the number of lines, the second one is a specific errorformat, else the default will be used.\n\nLua API:\n```lua\n    require(\"nvimux\").toggle()\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm42e%2Fnvimux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm42e%2Fnvimux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm42e%2Fnvimux/lists"}