KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #ai-agents #dsh-plugin #codex #developer-tools #claude-code #windows #cli #desktop-app #typescript #rust #ai-agent

telescope-tasks.nvim

★ 35 Open GitHub ↗

Run and preview the definitions and outputs of custom or auto-generated tasks from a telescope prompt

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Telescope tasks

`telescope-tasks.nvim` is a [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) extension,
that allows running tasks directly from the telescope prompt and displaying their
definitions and outputs in the telescope's previewer.

https://github.com/lpoto/telescope-tasks.nvim/assets/67372390/b085a6f3-3ab4-49f0-9109-6530f70e13e3
> **_NOTE_** This demo uses default generators for _Go_ and _Python_ projects. All available default generators
may be seen [here](./DEFAULT_GENERATORS.md), but you can easily write [custom](./CUSTOM_GENERATORS.md)
generators.

## Installation

The extension may be installed manually or with a plugin manager of choice.

An example using [Lazy.nvim](https://github.com/folke/lazy.nvim):

```lua
require("lazy").setup({
  "lpoto/telescope-tasks.nvim",
})
```

## Setup and usage

First setup and load the extension:

```lua
require("telescope").setup {
  extensions = {
    -- NOTE: this setup is optional
    tasks = {
      theme = "ivy",
      output = {
        style = "float", -- "split" | "float" | "tab"
        layout = "center", -- "left" | "right" | "center" | "below" | "above"
        scale = 0.4, -- output window to editor size ratio
        -- NOTE: scale and "center" layout are only relevant when style == "float"
      },
      env = {
        cargo = {
          -- Example environment used when running cargo projects
          RUST_LOG = "debug",
          -- ...
        },
        -- ...
      },
      binary = {
        -- Example binary used when running python projects
        python = "python3",
        -- ...
      },
      -- NOTE: environment and commands may be modified for each task separately from the picker

-- other picker setup values
    },
  },
}
-- Load the tasks telescope extension
require("telescope").load_extension "tasks"
```

> **_NOTE_**: If you encounter any issues, try `:checkhealth telescope-tasks`

See [Generators](#generators) on how to generate tasks.

Then use the extension:

```lua
:Telescope tasks
```

or in lua:

```lua
require("telescope").extensions.tasks.tasks()
```

> **_NOTE_**: See [Mappings](#mappings) for the default mappings in the tasks prompt

The last opened output may then be toggled with:

```lua
 require("telescope").extensions.tasks.actions.toggle_last_output()
```

## Generators

You may either use the [Default Generators](./DEFAULT_GENERATORS.md), or add [Custom Generators](./CUSTOM_GENERATORS.md).

## Mappings

| Key        | Description                                                     |
| ---------- | --------------------------------------------------------------- |
| `<CR>`     | Run the selected task, or kill it if it is already running.     |
| `<C-o>`    | Display the output of the selected task in another window.      |
| `e`        | Edit the selected task's associated file (only in normal mode). |
| `<C-r>`    | Remove the output of the selected task.                         |
| `<C-a>`    | Modify the selected task's command.                             |
| `<C-e>`    | Modify the selected task's environment variables.               |
| `<C-c>`    | Modify the selected task's working directory.                   |
| `<C-x>`    | Delete the task's modifications.                                |
| `<C-u>`    | Scroll the previewer up.                                        |
| `<C-d>`    | Scroll the previewer down.                                      |
| `<C-q>`    | Send a task's output to quickfix.                               |
| `o`        | same as `<C-o>` but only in normal mode.                        |
| `r` or `d` | same as `<C-r>` but only in normal mode.                        |

telescope-tasks.nvim

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README