@kabeep/neoconfig

NeoConfig

A Node.js CLI for the NeoFetch configuration file manager.

English | 简体中文

📖 Introduction

[!TIP]

By default, the themes directory is empty. You can add your custom configuration files or use configurations shared by the open-source community (see the "Related Repositories" section below).

Easily switch between custom NeoFetch themes from the command line, enabling quick transitions between presets for screen recording and presentation scenarios.

⚙️ Prerequisites

> Install NeoFetch. Without it, this package serves no purpose.

• NPM (Node.js)

  npm i -g neofetch
  

• Windows

  scoop i -g neofetch
  

• MacOS

  brew i -g neofetch
  

> Use a terminal that supports Unicode Symbols for the best experience with NeoFetch and NeoConfig.

Some terminals have limited or no support, especially those based on xterm-256color, like Microsoft/VSCode or Vercel/Hyper. See https://github.com/xtermjs/xterm.js/issues/2693 for details.

In such cases, you'll need to download a compatible font. We recommend Nerd Symbols Font, which is widely used in command-line applications.

After downloading the font, configure your terminal accordingly. For example, on Windows 11 and Hyper:

Install the font via Settings > Personalization > Fonts. Add the font name to the fontFamily setting in Hyper's configuration file. The same applies to editors like Sublime Text and VSCode.

📦 Installation

npm install --global @kabeep/neoconfig

yarn add --global @kabeep/neoconfig

pnpm add --global @kabeep/neoconfig

🚀 Usage

$ Show help_

neoconfig -h

neoconfig [options]

Options:
  -h, --help     Show help                                             [boolean]
  -v, --version  Show version number                                   [boolean]

$ Interactive configuration_

neoconfig

? Please select a neofetch theme.
❯ ⚙️ default.conf
  📁 large
  📁 small
  📁 termux
(Use arrow keys)
------------------
Press ▲  / ▼  to move the cursor.
Press ► / ENTER to enter the selected directory.
Press ◄ to return to the parent directory.
Press ENTER to switch themes.
Press CTRL - C to exit the interaction.

$ See more_

📄 Supported directory structure

~/.config/neofetch               # Root directory
├── config.conf                  # Current configuration file
└── themes                       # Fixed themes directory
    ├── default.conf             # Single configuration file
    ├── large                    # Grouped configurations (no restriction on directory names or nesting depth)
    │   ├── myTheme1             # Custom configuration
    │   │   ├── ascii.txt        # ASCII art file
    │   │   └── config.conf      # Configuration file
    │   ├── myTheme2             # Nested custom configuration
    │   │   ├── config.conf      # Configuration file
    │   │   └── assets           # Assets referenced by configuration (no restriction on directory names or nesting depth)
    │   │       └── ascii.txt    # ASCII art file
    │   └── ...
    ├── small
    └── ...

🌐 i18n

Language Name	Native Name	ISO-639-1	ISO-3166-1 (Alpha-2)	Locale File
English	-	en	US	en-US.ts
Chinese Simplified	简体中文	zh	CN	zh-CN.ts

🔗 Related

• neofetch-themes - Neofetch configs put into a convinient repository.
• NeoCat - NeoFetch Theme Pack.

🤝 Contribution

Contributions via Pull Requests or Issues are welcome.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.