sg.nvim

# sg.nvim

> [!IMPORTANT]  
> This plugin is currently experimental and is not actively being maintained. 

## Table of Contents

- [Setup](#setup)
- [Installation](#installation)
- [Configuration](#configuration)

sg.nvim is a plugin focused on bringing many of the features of sourcegraph.com and Cody into Neovim.

## Setup

To login, either:

- Run `:SourcegraphLogin` after following installation instructions for `sourcegraph.com` usage.
- Run `:SourcegraphLogin!` and provide an endpoint and access token to be stored.
- Use the `SRC_ENDPOINT` and `SRC_ACCESS_TOKEN` environment variables to manage tokens for enterprise usage.
  - See [src-cli](https://github.com/sourcegraph/src-cli#log-into-your-sourcegraph-instance) for more info

See `:help sg.auth` for more information.

You can check that you're logged in by then running `:checkhealth sg`

## Autocomplete

Currently, sg.nvim only supports nvim-cmp. For setup information, see: `:help cody.complete`.

If you have other completion sources you would like added, please let me know in the issue tracker!

## Installation

### Requirements

Requires:

- nvim 0.9 or nvim nightly
- Node.js >= 18.17.0 (LTS) at runtime for [`cody-agent.js`](https://github.com/sourcegraph/cody)

(By default, sg.nvim downloads released binaries from GitHub. If you prefer to build the plugin yourself, you'll need `cargo` to build)

- Currently uses plenary.nvim and telescope.nvim for some features.
  - If you would like to use something else for search functionality, please make an issue and I can look into adding support.

### Install

Regardless of installation method, you must call `require("sg").setup { ... }` in your config.

<details>
<summary><code>lazy.nvim</code></summary>

```lua
-- Use your favorite package manager to install, for example in lazy.nvim
--  Optionally, you can also install nvim-telescope/telescope.nvim to use some search functionality.
return {
  {
    "sourcegraph/sg.nvim",
    dependencies = { "nvim-lua/plenary.nvim", --[[ "nvim-telescope/telescope.nvim ]] },

    -- If you have a recent version of lazy.nvim, you don't need to add this!
    build = "nvim -l build/init.lua",
  },
}
```
</details>

<details>
<summary><code>packer.nvim</code></summary>

```lua
-- Packer.nvim, also make sure to install nvim-lua/plenary.nvim
use { 'sourcegraph/sg.nvim', run = 'nvim -l build/init.lua' }

-- You'll also need plenary.nvim
use { 'nvim-lua/plenary.nvim' }

-- And optionally, you can install telescope for some search functionality
--  "nvim-lua/plenary.nvim", --[[ "nvim-telescope/telescope.nvim ]]
```
</details>

<details>
<summary><code>vim-plug</code></summary>

```vimrc
" Using vim-plug
Plug 'sourcegraph/sg.nvim', { 'do': 'nvim -l build/init.lua' }

" Required for various utilities
Plug 'nvim-lua/plenary.nvim'

" Required if you want to use some of the search functionality
Plug 'nvim-telescope/telescope.nvim'
```
</details>

After installation, run `:checkhealth sg`.

(Nix instructions at the end of the