refactor(cli, nvim): some nix-friendly refactoring

- configurable executable path for the neovim plugin.
- Documentation mentions the Nix packages (for both CLI and nvim plugin).

Author: Davidyz

doc/VectorCode.txt

@@ -10,6 +10,7 @@ Table of Contents                               *VectorCode-table-of-contents*
   - Configuration                     |VectorCode-neovim-plugin-configuration|
   - API Usage                             |VectorCode-neovim-plugin-api-usage|
   - Debugging and Logging     |VectorCode-neovim-plugin-debugging-and-logging|
+2. Links                                                    |VectorCode-links|
 
 ==============================================================================
 1. NeoVim Plugin                                    *VectorCode-neovim-plugin*
@@ -22,6 +23,7 @@ Table of Contents                               *VectorCode-table-of-contents*
   [!NOTE] When the neovim plugin doesn’t work properly, please try upgrading
   the CLI tool to the latest version before opening an issue.
 - |VectorCode-installation|
+    - |VectorCode-nix|
 - |VectorCode-integrations|
 - |VectorCode-user-command|
     - |VectorCode-`vectorcode-register`|
@@ -91,6 +93,13 @@ you can use the following plugin spec:
   <https://archlinux.org/packages/extra/x86_64/neovim/> repository of Arch
   Linux).
 
+NIX ~
+
+There’s a community-maintained nix package
+<https://nixpk.gs/pr-tracker.html?pr=413395> submitted by @sarahec
+<https://github.com/sarahec> for the Neovim plugin.
+
+
 INTEGRATIONS                           *VectorCode-neovim-plugin-integrations*
 
 The wiki <https://github.com/Davidyz/VectorCode/wiki/Neovim-Integrations>
@@ -160,6 +169,9 @@ This function initialises the VectorCode client and sets up some default
 >lua
     -- Default configuration
     require("vectorcode").setup({
+      cli_cmds = {
+        vectorcode = "vectorcode",
+      },
       async_opts = {
         debounce = 10,
         events = { "BufWritePost", "InsertEnter", "BufReadPost" },
@@ -183,22 +195,25 @@ This function initialises the VectorCode client and sets up some default
 <
 
 The following are the available options for the parameter of this function: -
-`n_query`number of retrieved documents. A large number gives a higher chance of
-including the right file, but with the risk of saturating the context window
-and getting truncated. Default: `1`; - `notify`whether to show notifications
-when a query is completed. Default: `true`; - `timeout_ms`timeout in
-milliseconds for the query operation. Applies to synchronous API only. Default:
-`5000` (5 seconds); - `exclude_this`whether to exclude the file you’re
-editing. Setting this to `false` may lead to an outdated version of the current
-file being sent to the LLM as the prompt, and can lead to generations with
-outdated information; - `async_opts`default options used when registering
-buffers. See |VectorCode-`register_buffer(bufnr?,-opts?)`| for details; -
-`async_backend`the async backend to use, currently either `"default"` or
-`"lsp"`. Default: `"default"`; - `on_setup`some actions that can be registered
-to run when `setup` is called. Supported keys: - `update`if `true`, the plugin
-will run `vectorcode update` on startup to update the embeddings; - `lsp`if
-`true`, the plugin will try to start the LSP server on startup so that you
-won’t need to wait for the server loading when making your first request. -
+`cli_cmds`A table to customize the CLI command names / paths used by the
+plugin. Supported key: - `vectorcode`The command / path to use for the main CLI
+tool. Default: `"vectorcode"`. - `n_query`number of retrieved documents. A
+large number gives a higher chance of including the right file, but with the
+risk of saturating the context window and getting truncated. Default: `1`; -
+`notify`whether to show notifications when a query is completed. Default:
+`true`; - `timeout_ms`timeout in milliseconds for the query operation. Applies
+to synchronous API only. Default: `5000` (5 seconds); - `exclude_this`whether
+to exclude the file you’re editing. Setting this to `false` may lead to an
+outdated version of the current file being sent to the LLM as the prompt, and
+can lead to generations with outdated information; - `async_opts`default
+options used when registering buffers. See
+|VectorCode-`register_buffer(bufnr?,-opts?)`| for details; - `async_backend`the
+async backend to use, currently either `"default"` or `"lsp"`. Default:
+`"default"`; - `on_setup`some actions that can be registered to run when
+`setup` is called. Supported keys: - `update`if `true`, the plugin will run
+`vectorcode update` on startup to update the embeddings; - `lsp`if `true`, the
+plugin will try to start the LSP server on startup so that you won’t need to
+wait for the server loading when making your first request. -
 `sync_log_env_var``boolean`. If true, this plugin will automatically set the
 `VECTORCODE_LOG_LEVEL` environment variable for LSP or cmd processes started
 within your neovim session when logging is turned on for this plugin. Use at
@@ -512,6 +527,11 @@ variable to a supported log level
 The log file will be written to `stdpath("log")` or `stdpath("cache")`. On
 Linux, this is usually `~/.local/state/nvim/`.
 
+==============================================================================
+2. Links                                                    *VectorCode-links*
+
+1. *@sarahec*: 
+
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 
 vim:tw=78:ts=8:noet:ft=help:norl:

docs/cli.md

@@ -8,6 +8,7 @@
   * [Chromadb](#chromadb)
     * [For Windows Users](#for-windows-users)
   * [Legacy Environments](#legacy-environments)
+  * [Nix](#nix)
 * [Getting Started](#getting-started)
   * [Refreshing Embeddings](#refreshing-embeddings)
   * [If Anything Goes Wrong...](#if-anything-goes-wrong)
@@ -107,6 +108,11 @@ numpy `v1.x`. If this doesn't help, please open an issue with your OS, CPU
 architecture, python version and the vectorcode virtual environment 
 (`pipx runpip vectorcode freeze`).
 
+### Nix
+
+A community-maintained Nix package is available 
+[here](https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=vectorcode).
+
 ## Getting Started
 
 `cd` into your project root repo, and run:

docs/neovim.md

@@ -12,6 +12,7 @@
 <!-- mtoc-start -->
 
 * [Installation](#installation)
+  * [Nix](#nix)
 * [Integrations](#integrations)
 * [User Command](#user-command)
   * [`VectorCode register`](#vectorcode-register)
@@ -80,6 +81,11 @@ you can use the following plugin spec:
 > [Extra](https://archlinux.org/packages/extra/x86_64/neovim/) 
 > repository of Arch Linux).
 
+### Nix
+
+There's a community-maintained [nix package](https://nixpk.gs/pr-tracker.html?pr=413395) 
+submitted by [@sarahec](https://github.com/sarahec) for the Neovim plugin.
+
 ## Integrations
 
 [The wiki](https://github.com/Davidyz/VectorCode/wiki/Neovim-Integrations)
@@ -137,6 +143,9 @@ This function initialises the VectorCode client and sets up some default
 ```lua
 -- Default configuration
 require("vectorcode").setup({
+  cli_cmds = {
+    vectorcode = "vectorcode",
+  },
   async_opts = {
     debounce = 10,
     events = { "BufWritePost", "InsertEnter", "BufReadPost" },
@@ -160,6 +169,9 @@ require("vectorcode").setup({
 ```
 
 The following are the available options for the parameter of this function:
+- `cli_cmds`: A table to customize the CLI command names / paths used by the plugin.
+  Supported key:
+  - `vectorcode`: The command / path to use for the main CLI tool. Default: `"vectorcode"`.
 - `n_query`: number of retrieved documents. A large number gives a higher chance
   of including the right file, but with the risk of saturating the context 
   window and getting truncated. Default: `1`;

lua/vectorcode/config.lua

@@ -15,6 +15,9 @@ local cacher = nil
 
 ---@type VectorCode.Opts
 local config = {
+  cli_cmds = {
+    vectorcode = "vectorcode",
+  },
   async_opts = {
     debounce = 10,
     events = { "BufWritePost", "InsertEnter", "BufReadPost" },
@@ -24,6 +27,7 @@ local config = {
     query_cb = require("vectorcode.utils").make_surrounding_lines_cb(-1),
     run_on_register = false,
     single_job = false,
+    timeout_ms = 5000,
   },
   async_backend = "default",
   exclude_this = true,
@@ -40,7 +44,7 @@ local setup_config = vim.deepcopy(config, true)
 local lsp_configs = function()
   ---@type vim.lsp.ClientConfig
   local cfg =
-    { cmd = { "vectorcode-server" }, root_markers = { ".vectorcode", ".git" } }
+    { cmd = { "vectorcode-server" }, root_markers = { ".vectorcode", ".git" } } -- NOTE: This can be overriden by `vim.lsp.config`
   if vim.lsp.config ~= nil and vim.lsp.config.vectorcode_server ~= nil then
     -- nvim >= 0.11.0
     cfg = vim.tbl_deep_extend("force", cfg, vim.lsp.config.vectorcode_server)
@@ -73,7 +77,7 @@ local notify_opts = { title = "VectorCode" }
 ---@param opts {notify:boolean}?
 local has_cli = function(opts)
   opts = opts or { notify = false }
-  local ok = vim.fn.executable("vectorcode") == 1
+  local ok = vim.fn.executable(setup_config.cli_cmds.vectorcode) == 1
   if not ok and opts.notify then
     vim.notify("VectorCode CLI is not executable!", vim.log.levels.ERROR, notify_opts)
   end
@@ -140,6 +144,8 @@ return {
           )
         end
       end
+      setup_config.cli_cmds.vectorcode =
+        vim.fs.normalize(setup_config.cli_cmds.vectorcode)
       startup_handler(setup_config)
       logger.info("Finished processing opts:\n", setup_config)
     end

lua/vectorcode/jobrunner/cmd.lua

@@ -12,15 +12,12 @@ function runner.run_async(args, callback, bufnr)
   else
     callback = nil
   end
-  local cmd = { "vectorcode" }
-  args = require("vectorcode.jobrunner").find_root(args, bufnr)
-  vim.list_extend(cmd, args)
   logger.debug(
     ("cmd jobrunner for buffer %s args: %s"):format(bufnr, vim.inspect(args))
   )
   ---@diagnostic disable-next-line: missing-fields
   local job = Job:new({
-    command = "vectorcode",
+    command = require("vectorcode.config").get_user_config().cli_cmds.vectorcode,
     args = args,
     on_exit = function(self, code, signal)
       jobs[self.pid] = nil
@@ -49,9 +46,13 @@ function runner.run_async(args, callback, bufnr)
       end
     end,
   })
-  job:start()
-  jobs[job.pid] = job
-  return tonumber(job.pid)
+  local ok = pcall(job.start, job)
+  if ok then
+    jobs[job.pid] = job
+    return tonumber(job.pid)
+  else
+    logger.error("Failed to start job.")
+  end
 end
 
 function runner.run(args, timeout_ms, bufnr)

lua/vectorcode/jobrunner/lsp.lua

@@ -1,17 +1,11 @@
-if
-  vim.fn.executable("vectorcode-server") ~= 1
-  or vim.system({ "vectorcode-server", "--version" }):wait().code ~= 0
-then
-  return nil
-end
+local vc_config = require("vectorcode.config")
 
 ---@type VectorCode.JobRunner
 local jobrunner = {}
 
 ---@type vim.lsp.Client
 local CLIENT = nil
 
-local vc_config = require("vectorcode.config")
 local notify_opts = vc_config.notify_opts
 local logger = vc_config.logger
 
@@ -93,6 +87,7 @@ function jobrunner.run_async(args, callback, bufnr)
   )
   local _, id = CLIENT:request(
     vim.lsp.protocol.Methods.workspace_executeCommand,
+    -- NOTE: This is not a hardcoded executable, but rather part of our LSP implementation.
     { command = "vectorcode", arguments = args },
     function(err, result, _, _)
       if type(callback) == "function" then

lua/vectorcode/types.lua

@@ -23,9 +23,13 @@
 ---@field update boolean `vectorcode update`
 ---@field lsp boolean whether to start LSP server on startup (default is to delay it to the first LSP request)
 
+---@class VectorCode.CliCmds Cli commands to use
+---@field vectorcode string vectorcode cli command or full path
+
 ---Options passed to `setup`.
 ---@class VectorCode.Opts : VectorCode.QueryOpts
 ---@field async_opts VectorCode.RegisterOpts Default options to use for registering a new buffer for async cache.
+---@field cli_cmds VectorCode.CliCmds
 ---@field on_setup VectorCode.OnSetup
 ---@field async_backend "default"|"lsp"
 ---@field sync_log_env_var boolean Whether to automatically set `VECTORCODE_LOG_LEVEL` when `VECTORCODE_NVIM_LOG_LEVEL` is detected. !! WARNING: THIS MAY RESULT IN EXCESSIVE LOG MESSAGES DUE TO STDERR BEING POPULATED BY CLI LOGS

src/vectorcode/lsp_main.py

@@ -7,6 +7,8 @@
 import traceback
 import uuid
 
+import shtab
+
 try:  # pragma: nocover
     from lsprotocol import types
     from pygls.exceptions import (
@@ -64,6 +66,12 @@ def get_arg_parser():
         type=str,
         default="",
     )
+    shtab.add_argument_to(
+        parser,
+        ["-s", "--print-completion"],
+        parent=parser,
+        help="Print completion script.",
+    )
     return parser
 
 

src/vectorcode/mcp_main.py

@@ -7,6 +7,7 @@
 from pathlib import Path
 from typing import Optional
 
+import shtab
 from chromadb.api import AsyncClientAPI
 from chromadb.api.models.AsyncCollection import AsyncCollection
 from chromadb.errors import InvalidCollectionException
@@ -60,6 +61,12 @@ def get_arg_parser():
         default=False,
         help="Whether to include the output of `vectorcode ls` in the tool description.",
     )
+    shtab.add_argument_to(
+        parser,
+        ["-s", "--print-completion"],
+        parent=parser,
+        help="Print completion script.",
+    )
     return parser