Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.21 KB

README.markdown

File metadata and controls

50 lines (35 loc) · 1.21 KB

SHELLEY.NVIM 🐚 ✒️

A small Neovim extension to execute shell commands as Neovim commands. 🐚 ✒️

ABOUT 📚

This repository contains the source code for a Neovim plugin that lets you execute shell commands from the Neovim command line. To enable this functionality, Shelley provides a Neovim command.

INSTALLATION

To install Shelley, use the plugin manager of your choice. To use Shelley with LazyVim, you would add the following spec code to your LazyVim configuration:

return {
  'alyxshang/shelley.nvim',
  config = function()
    require("shelley").setup()
  end
}

USAGE ⚙️

To run a shell command from the Neovim command prompt, the Shelley command is used. The command takes one argument, namely the shell command to run. The example below demonstrates how to use this command:

:Shelley "echo 'Hello World!'"

Please note that the shell command must be surrounded by double quotes.

CHANGELOG 📜

Version 0.1.0

  • Upload to GitHub.
  • Initial release.

NOTE 📜

  • Shelly.nvim 🐚 ✒️ by Alyx Shang 🖤.
  • Licensed under the FSL v1.