🚀 FkNeoInstaller

Your dynamic Neovim setup wizard.

🧩 Why FkNeoInstaller?

FkNeoInstaller is a powerful command-line tool that simplifies setting up and managing your Neovim configuration.
Whether you’re a seasoned developer or new to Neovim, FkNeoInstaller helps you create a feature-rich, personalized environment in minutes — no manual setup required.

✨ Features

• 🚀 Interactive Setup: Guided wizard to configure Neovim from scratch.
• 📦 Pre-built Configurations: One-command install for popular Neovim setups:
  • FkVim
  • LazyVim
  • NvChad
  • LunarVim
• 🎨 Custom Generator: Generate a tailored Neovim configuration for your workflow.
• 🧹 Clean & Reset: Remove installed configurations and manage shell aliases easily.
• 🔒 GitHub Authentication: Securely connect to GitHub to use private configs.

⚙️ Installation

Install FkNeoInstaller globally using your preferred package manager:

# With npm
npm install -g fkneo-installer

# With yarn
yarn global add fkneo-installer

# With pnpm
pnpm add -g fkneo-installer

🖥️ Usage

Launch the interactive CLI:

fkneo

Manage your Neovim setup directly from the terminal.

⚡ Quick Install

For non-interactive setup, use:

fkneo install <preset> [options]

Examples:

# Install FkVim
fkneo install --fkvim

# Install LazyVim and set it as the main config
fkneo install --lazyvim --main

# Install NvChad with a custom alias
fkneo install --nvchad --alias mychad

🧰 Commands

| Command | Description | | --------------- | ----------------------------------------------- | | help | Show the help menu with all available commands. | | setup | Launch the interactive setup wizard. | | install | Install a pre-built Neovim configuration. | | generate | Generate a custom Neovim configuration. | | clean | Remove installed presets and clean up aliases. | | reset-auth | Clear saved GitHub credentials. | | quit / exit | Exit the CLI. |

🧾 Configuration

FkNeoInstaller stores its configuration in:

~/.config/FkNeoInstaller/config.json

This includes authentication tokens and metadata about your installed setups. You can clear it anytime using the reset-auth command.

🤝 Contributing

Contributions are welcome! If you have ideas, issues, or improvements — please open a PR or create an issue on GitHub.

📜 License

Licensed under the MIT License.