https://github.com/mehalter/zsh-nvim-appname

A simple ZSH plugin for maintaining multiple Neovim configurations with NVIM_APPNAME
https://github.com/mehalter/zsh-nvim-appname

appname neovim neovim-config neovim-configuration nvim nvim-appname nvim-configs nvim-configuration zsh zsh-plugin

Last synced: 3 months ago
JSON representation

A simple ZSH plugin for maintaining multiple Neovim configurations with NVIM_APPNAME

• Host: GitHub
• URL: https://github.com/mehalter/zsh-nvim-appname
• Owner: mehalter
• License: gpl-3.0
• Created: 2023-03-06T14:36:07.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-17T18:19:08.000Z (9 months ago)
• Last Synced: 2024-08-07T18:44:11.617Z (6 months ago)
• Topics: appname, neovim, neovim-config, neovim-configuration, nvim, nvim-appname, nvim-configs, nvim-configuration, zsh, zsh-plugin
• Language: Shell
• Homepage:
• Size: 25.4 KB
• Stars: 15
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# zsh-nvim-appname

A simple ZSH plugin for maintaining multiple Neovim configurations with `NVIM_APPNAME` with full tab completion of available flags, available neovim applications, and neovim arguments/flags.

Requirements: Neovim v0.9+

## Short Demo

[![Recorded Demo](https://asciinema.org/a/mdy5Cv1q79vOwjdQJauHv1NNn.svg)](https://asciinema.org/a/mdy5Cv1q79vOwjdQJauHv1NNn)

## Usage

This creates a new command `nvapp` which takes an `appname` of a folder `named nvim_` in your `$XDG_CONFIG_HOME` and passes it into neovim using the `NVIM_APPNAME` environment variable.

```

Usage:

  nvapp [-h|--help] [-c|--clean] [-d|--delete]  ...

Options:

  -h|--help     Display this help text and exit

  -c|--clean    Clean the installation files

  -d|--delete   Fully delete the neovim app

       The name of the neovim app in $XDG_CONFIG_HOME

                (Example. ~/.config/nvim_)

  ...           any arguments passed to neovim

```

## Installation

- [Antigen](#antigen)

- [Oh My Zsh](#oh-my-zsh)

- [Manual](#manual-git-clone)

### Antigen

1. Add the following to your `.zshrc`:

   ```sh

   antigen bundle mehalter/zsh-nvim-appname

   ```

2. Start a new terminal session.

### Oh My Zsh

1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`)

   ```sh

   git clone https://github.com/mehalter/zsh-nvim-appname ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-nvim-appname

   ```

2. Add the plugin to the list of plugins for Oh My Zsh to load (inside `~/.zshrc`):

   ```sh

   plugins=(

       # other plugins...

       zsh-nvim-appname

   )

   ```

3. Start a new terminal session.

### Manual (Git Clone)

1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`.

   ```sh

   git clone https://github.com/mehalter/zsh-nvim-appname ~/.zsh/zsh-nvim-appname

   ```

2. Add the following to your `.zshrc`:

   ```sh

   source ~/.zsh/zsh-nvim-appname/zsh-nvim-appname.plugin.zsh

   fpath+= ~/.zsh/zsh-nvim-appname

   ```

3. Start a new terminal session.