Commands Reference¶
Complete reference for all nvp commands.
Global Flags¶
These flags are available on every command:
| Flag | Description |
|---|---|
--config <path> |
Path to config file |
-v, --verbose |
Enable debug logging |
--log-file <path> |
Write logs to file (JSON format) |
--no-color |
Disable color output |
-h, --help |
Show help for any command |
Initialization¶
nvp init¶
Initialize the nvp store.
Creates the ~/.nvp/ directory structure.
Plugin Management¶
nvp list¶
List all installed plugins.
nvp get¶
Get details of an installed plugin.
Flags:
| Flag | Description |
|---|---|
-o, --output <format> |
Output format: json, yaml, table |
Examples:
nvp enable¶
Enable an installed plugin.
Example:
nvp disable¶
Disable an installed plugin without deleting it.
Example:
nvp delete¶
Delete an installed plugin.
Example:
Applying Resources¶
nvp apply¶
Apply a plugin or theme from a source.
Source types:
| Type | Example |
|---|---|
| Local file | plugin.yaml |
| URL | https://example.com/plugin.yaml |
| GitHub shorthand | github:user/repo/path/plugin.yaml |
| Stdin | - |
Examples:
# From a local file
nvp apply -f my-plugin.yaml
# From a URL
nvp apply -f https://example.com/plugin.yaml
# From GitHub
nvp apply -f github:rmkohlman/nvim-yaml-plugins/plugins/telescope.yaml
# From stdin
cat plugin.yaml | nvp apply -f -
Plugin Library¶
nvp library list¶
List plugins available in the built-in library.
Flags:
| Flag | Description |
|---|---|
--category <cat> |
Filter by category |
--tags <tags> |
Filter by tags |
Examples:
nvp library show¶
Show details of a library plugin.
Example:
nvp library install¶
Install a plugin from the library.
Examples:
nvp library categories¶
List available plugin categories in the library.
nvp library tags¶
List available plugin tags in the library.
Source Management¶
nvp source list¶
List configured plugin sources.
nvp source show¶
Show details of a source.
nvp source sync¶
Sync plugins from a configured source.
Flags:
| Flag | Description |
|---|---|
--dry-run |
Preview what would be synced without applying |
-l, --selector <key=value> |
Filter by label selector |
--tag <tag> |
Filter by tag |
-f, --force |
Overwrite existing plugins |
-o, --output <format> |
Output format: json, yaml, table |
Examples:
nvp source sync my-team-plugins
nvp source sync my-team-plugins --dry-run
nvp source sync my-team-plugins --tag lsp
nvp source sync my-team-plugins --force
Theme Management¶
nvp theme list¶
List all available themes (library + user).
nvp theme get¶
Get theme details. If no name is provided, shows the active theme.
Flags:
| Flag | Description |
|---|---|
-o, --output <format> |
Output format: json, yaml, table |
Examples:
nvp theme use¶
Set the active theme.
Examples:
nvp theme create¶
Create a custom CoolNight variant using the parametric generator.
The --from value can be:
- A hue angle in degrees ("210")
- A hex color ("#8B00FF")
- A named preset ("synthwave", "ocean", "forest")
Flags:
| Flag | Required | Description |
|---|---|---|
--from <value> |
Yes | Base: hue (0–360), hex (#rrggbb), or preset name |
--name <name> |
Yes | Name for the new theme |
--use |
No | Set the new theme as active after creation |
Examples:
nvp theme create --from "210" --name my-blue-theme
nvp theme create --from "#8B00FF" --name my-violet-theme
nvp theme create --from "synthwave" --name my-synth --use
nvp theme preview¶
Preview a theme's colors in the terminal.
Example:
nvp theme delete¶
Delete a user theme.
Example:
nvp theme generate¶
Generate Lua files for the active theme only.
Theme Library¶
nvp theme library list¶
List themes available in the library.
Flags:
| Flag | Description |
|---|---|
--category <cat> |
Filter by category |
Examples:
nvp theme library show¶
Show details of a library theme.
Example:
nvp theme library install¶
Install a theme from the library to ~/.nvp/themes/.
Flags:
| Flag | Description |
|---|---|
--use |
Set the theme as active after installing |
Examples:
nvp theme library categories¶
List available theme categories.
nvp theme library tags¶
List available theme tags.
Configuration¶
nvp config init¶
Initialize the nvp configuration file.
nvp config show¶
Show current configuration.
nvp config generate¶
Generate a default configuration file.
nvp config edit¶
Open the configuration file in your editor.
Generation¶
nvp generate¶
Generate Lua files from installed plugins and the active theme.
Flags:
| Flag | Description |
|---|---|
-o, --output <dir> |
Output directory (default: ~/.config/nvim/lua/plugins/nvp) |
Examples:
nvp generate-lua¶
Alias for nvp generate.
Shell Completion¶
nvp completion¶
Generate shell completion scripts.
Supported shells: bash, zsh, fish, powershell
Examples:
Version¶
nvp version¶
Show version information.
Common Workflows¶
Install Plugins from Library¶
nvp library list
nvp library list --category lsp
nvp library install telescope
nvp library install treesitter
nvp library install lspconfig
nvp generate
Apply from a YAML File¶
nvp apply -f my-plugin.yaml
nvp apply -f https://example.com/my-plugin.yaml
nvp apply -f github:rmkohlman/nvim-yaml-plugins/plugins/telescope.yaml
nvp generate
Create and Use a Custom Theme¶
# By hue angle
nvp theme create --from "280" --name my-synthwave --use
# By hex color
nvp theme create --from "#8B00FF" --name my-violet --use
# Generate Lua files
nvp generate