https://github.com/franco-ruggeri/codecompanion-lualine.nvim
Lualine component for CodeCompanion
https://github.com/franco-ruggeri/codecompanion-lualine.nvim
Last synced: 3 months ago
JSON representation
Lualine component for CodeCompanion
- Host: GitHub
- URL: https://github.com/franco-ruggeri/codecompanion-lualine.nvim
- Owner: franco-ruggeri
- License: mit
- Created: 2025-07-07T00:12:06.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-07-07T01:54:54.000Z (5 months ago)
- Last Synced: 2025-07-07T02:24:45.082Z (5 months ago)
- Language: Lua
- Size: 4.88 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🧩 CodeCompanion Lualine
## 📖 Overview
A simple [lualine](https://github.com/nvim-lualine/lualine.nvim) component for
[CodeCompanion](https://github.com/olimorris/codecompanion.nvim), providing a
status indicator with the number of active CodeCompanion requests.
## ✨ Features
- Displays the number of active CodeCompanion requests.
- Shows a spinner while requests are active, and a checkmark (✓) when idle.
- Includes an icon and can be customized.
## 🚀 Installation
With [lazy.nvim](https://github.com/folke/lazy.nvim):
```lua
return {
"nvim-lualine/lualine.nvim",
dependencies = {
"franco-ruggeri/codecompanion-lualine.nvim",
-- Other dependencies
},
opts = {
sections = {
lualine_x = {
"codecompanion",
-- Other components
},
},
},
}
```
The component will be enabled only after CodeCompanion is loaded, respecting its
lazy-loading options. Thus, it is recommended that you do not add CodeCompanion
as a dependency of lualine.
## 🛠️ Customization
You can customize the component by passing the following options:
```lua
require('lualine').setup {
sections = {
lualine_x = {
{
"codecompanion",
icon = " ",
spinner_symbols = { "⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏" },
done_symbol = "✓",
},
},
},
}
```
## 🙏 Acknowledgements
This plugin is based on the [example from the official
documentation](https://codecompanion.olimorris.dev/usage/ui.html#lualine-nvim-integration).