Skip to content

Commit e64d7a5

Browse files
committed
add minimal readme
1 parent 5d3472d commit e64d7a5

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# codegate.nvim
2+
3+
CodeGate.nvim is a Neovim plugin that interfaces with CodeGate—a secure local gateway for AI code generation that ensures best practices and protects your code and privacy.
4+
5+
## Overview
6+
7+
This plugin allows you to:
8+
- **List Workspaces:** Display available workspaces from your CodeGate API.
9+
- **Activate Workspaces:** Set an active workspace.
10+
- **Telescope Integration:** Use a fuzzy finder to select workspaces (if [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim) is installed).
11+
12+
## Installation
13+
14+
Using **lazy.nvim**, you can use the following code snippet to install and configure **codegate.nvim**:
15+
16+
```lua
17+
{
18+
"stacklok/codegate.nvim",
19+
config = function()
20+
require("codegate").setup({
21+
base_url = "http://127.0.0.1:8989",
22+
})
23+
end,
24+
}
25+
```
26+
27+
## Usage
28+
29+
- **List Workspaces**: Run `:CodeGateListWorkspaces` to display available workspaces.
30+
- **Activate a Workspace**: Run `:CodeGateSetWorkspace <workspace>` to activate a specific workspace.
31+
- **Telescope Picker**: If **telescope.nvim** is installed, run `:CodeGateTelescopeWorkspaces` to open a fuzzy search picker.
32+
33+

0 commit comments

Comments
 (0)