Pieces for Developers | Neovim Plugin

Important

Please make sure you have Pieces OS installed to run the Package.

Getting Started with the Pieces Neovim Plugin

Welcome to the Pieces Neovim Plugin!

Neovim Plugin offers extensive functionality to interact with Pieces OS.

Installation

Using vim-plug

1. Add the following lines to your init.vim or init.lua:

" init.vim
call plug#begin('~/.vim/plugged')

Plug 'kyazdani42/nvim-web-devicons'
Plug 'MunifTanjim/nui.nvim'
Plug 'hrsh7th/nvim-cmp'
Plug 'pieces-app/plugin_neovim'

call plug#end()

Install the plugins by running :PlugInstall in Neovim.

Using packer.nvim

1. Add the following lines to your init.lua:

-- init.lua
vim.cmd [[packadd packer.nvim]]

return require('packer').startup(function()
  use 'kyazdani42/nvim-web-devicons'
  use 'MunifTanjim/nui.nvim'
  use 'hrsh7th/nvim-cmp'
  use 'pieces-app/plugin_neo_vim'
end)

Install the plugins by running :PackerSync in Neovim.

2. download python and pynvim (pip install pynvim)

3. Run :UpdateRemotePlugins

Configuration

After installing the plugin, you can configure the host by adding the following lines to your init.vim or init.lua:

require("pieces.config").host = "http://localhost:1000"

By default the host will be http://localhost:1000 on Windows and MacOS and http://localhost:5323 on Linux

Commands

The Pieces Neovim plugin provides several commands to interact with Pieces OS. Here's a list of available commands:

General Commands

:PiecesHealth

Check the health of Pieces OS.

:PiecesHealth

:PiecesOSVersion

Display the version of Pieces OS.

:PiecesOSVersion

:PiecesPluginVersion

Display the current version of the Pieces Neovim plugin.

:PiecesPluginVersion

Copilot Commands

:PiecesCopilot

Open the Pieces Copilot window in a split view.

:PiecesCopilot

Using the Copilot Chat

1. Press i to enter insert mode and type your message.
2. Press <Esc> to exit insert mode.
3. Press <Enter> to send the message to Pieces Copilot and see the response.

Copilot Chat Commands

In the Copilot chat input, you can use slash commands to perform specific actions:

/change_model

Change the current LLM model.

:PiecesConversations

Open a list of Pieces Copilot conversations to choose from.

:PiecesConversations

Navigation and actions:

• Press <Del> on the selected conversation to delete it
• Use <Up> and <Down> arrow keys to navigate the conversation list
• Press <Enter> to open the selected conversation in the Copilot

Asset Management Commands

:PiecesSnippets

List all of the saved snippets.

:PiecesSnippets

Navigation and actions:

• Use <Up> and <Down> arrow keys to navigate the snippet list.
• Press <Enter> to open the selected snippet for editing.
• Press <Del> on the selected snippet to delete it.
• When editing a snippet:
  1. Press i to enter insert mode and make changes.
  2. Press <Esc> to exit insert mode.
  3. Type :w and press <Enter> to save the edited snippet.
  4. Type :q and press <Enter> to exit the snippet editor.

:PiecesCreateSnippet

Create a snippet from the selected text in the visual mode.

:PiecesCreateSnippet

1. Enter visual mode by pressing v in normal mode.
2. Select the desired text using arrow keys or Vim motions.
3. Type :PiecesCreateSnippet and press <Enter>.

Auth Commands

:PiecesAccount

Shows your Pieces account information such as Username, Email, Personal Cloud Status and Personal Domain in a new window.

:PiecesAccount

You can also logout from your account by going to the Logout option in the Auth status menu and then press enter. You will be logged out of your Pieces account.

:PiecesLogin

Login to your Pieces account.

:PiecesLogin

:PiecesLogout

Logout of your Pieces account.

:PiecesLogout

:PiecesConnectCloud

Connect to your Personal Pieces Cloud.

:PiecesConnectCloud

:PiecesDisconnectCloud

Disconnect from your Personal Pieces Cloud.

:PiecesDisconnectCloud

Note: In order to use the Personal Pieces Cloud commands, you must have an account connected to Pieces OS.