{"id":27290931,"url":"https://github.com/kabeep/neoconfig","last_synced_at":"2025-04-11T21:39:38.302Z","repository":{"id":271493242,"uuid":"913565886","full_name":"kabeep/neoconfig","owner":"kabeep","description":"\u003e A Node.js CLI for the NeoFetch configuration file manager._","archived":false,"fork":false,"pushed_at":"2025-01-09T00:08:48.000Z","size":1243,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-10T04:11:19.504Z","etag":null,"topics":["cli","file-manager","neoconfig","neofetch","nodejs"],"latest_commit_sha":null,"homepage":"https://github.com/kabeep/neoconfig","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kabeep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-07T23:49:58.000Z","updated_at":"2025-01-20T16:44:35.000Z","dependencies_parsed_at":"2025-01-08T05:24:24.155Z","dependency_job_id":"36d4272f-d34b-4e1c-bc1c-ae25c73c8bee","html_url":"https://github.com/kabeep/neoconfig","commit_stats":null,"previous_names":["kabeep/neoconfig"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fneoconfig","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fneoconfig/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fneoconfig/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kabeep%2Fneoconfig/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kabeep","download_url":"https://codeload.github.com/kabeep/neoconfig/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248378851,"owners_count":21094062,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","file-manager","neoconfig","neofetch","nodejs"],"created_at":"2025-04-11T21:39:37.598Z","updated_at":"2025-04-11T21:39:38.291Z","avatar_url":"https://github.com/kabeep.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ch1\u003eNeoConfig\u003c/h1\u003e\n\nA Node.js CLI for the `NeoFetch` configuration file manager.\n\n[![NodeJS][node-image]][node-url]\n[![Install Size][install-size-image]][install-size-url]\n[![NPM][npm-image]][npm-url]\n[![code style][code-style-image]][code-style-url]\n[![License][license-image]][license-url]\n\nEnglish | [简体中文][zh-cn-url]\n\n\u003cimg width=\"720\" src=\"docs/images/preview.png\" alt=\"preview-png\"\u003e\n\n\u003c/div\u003e\n\n## 📖 Introduction\n\n\u003e [!TIP]\n\u003e\n\u003e By default, the themes directory is empty. You can add your custom configuration files or use configurations shared by\n\u003e the open-source community (see the \"Related Repositories\" section below).\n\nEasily switch between custom NeoFetch themes from the command line, enabling quick transitions between presets for\nscreen recording and presentation scenarios.\n\n## ⚙️ Prerequisites\n\n***\\\u003e Install [NeoFetch][neofetch-url]. Without it, this package serves no purpose.***\n\n1. NPM ([Node.js][node-url])\n    ```bash\n    npm i -g neofetch\n    ```\n\n2. Windows\n    ```bash\n    scoop i -g neofetch\n    ```\n\n3. MacOS\n    ```bash\n    brew i -g neofetch\n    ```\n\n***\\\u003e Use a terminal that supports Unicode Symbols for the best experience with `NeoFetch` and `NeoConfig`.***\n\nSome terminals have limited or no support, especially those based on `xterm-256color`, like `Microsoft/VSCode` or\n`Vercel/Hyper`.\nSee https://github.com/xtermjs/xterm.js/issues/2693 for details.\n\nIn such cases, you'll need to download a compatible font. We recommend [Nerd Symbols Font][nerd-url], which is widely\nused in command-line applications.\n\nAfter downloading the font, configure your terminal accordingly. For example, on Windows 11 and Hyper:\n\nInstall the font via `Settings` \u003e `Personalization` \u003e `Fonts`.\nAdd the font name to the `fontFamily` setting in `Hyper`'s configuration file.\nThe same applies to editors like `Sublime Text` and `VSCode`.\n\n## 📦 Installation\n\n```bash\nnpm install --global @kabeep/neoconfig\n```\n\n```bash\nyarn add --global @kabeep/neoconfig\n```\n\n```bash\npnpm add --global @kabeep/neoconfig\n```\n\n## 🚀 Usage\n\n#### \\$ Show help_\n\n```bash\nneoconfig -h\n```\n\n```\nneoconfig [options]\n\nOptions:\n  -h, --help     Show help                                             [boolean]\n  -v, --version  Show version number                                   [boolean]\n```\n\n#### \\$ Interactive configuration_\n\n```bash\nneoconfig\n```\n\n```\n? Please select a neofetch theme.\n❯ ⚙️ default.conf\n  📁 large\n  📁 small\n  📁 termux\n(Use arrow keys)\n------------------\nPress ▲  / ▼  to move the cursor.\nPress ► / ENTER to enter the selected directory.\nPress ◄ to return to the parent directory.\nPress ENTER to switch themes.\nPress CTRL - C to exit the interaction.\n```\n\n#### $ See more_\n\n\u003ca href=\"https://asciinema.org/a/697570\"\u003e\n   \u003cimg width=\"630\" alt=\"asciinema\" src=\"https://asciinema.org/a/697570.svg\"\u003e\n\u003c/a\u003e\n\n## 📄 Supported directory structure\n\n```\n~/.config/neofetch               # Root directory\n├── config.conf                  # Current configuration file\n└── themes                       # Fixed themes directory\n    ├── default.conf             # Single configuration file\n    ├── large                    # Grouped configurations (no restriction on directory names or nesting depth)\n    │   ├── myTheme1             # Custom configuration\n    │   │   ├── ascii.txt        # ASCII art file\n    │   │   └── config.conf      # Configuration file\n    │   ├── myTheme2             # Nested custom configuration\n    │   │   ├── config.conf      # Configuration file\n    │   │   └── assets           # Assets referenced by configuration (no restriction on directory names or nesting depth)\n    │   │       └── ascii.txt    # ASCII art file\n    │   └── ...\n    ├── small\n    └── ...\n```\n\n## 🌐 i18n\n\n| Language Name      | Native Name | ISO-639-1 | ISO-3166-1 (Alpha-2) | Locale File                  |\n|:-------------------|:-----------:|:---------:|:--------------------:|:-----------------------------|\n| English            |      -      |    en     |          US          | [en-US.ts][locale-en-us-url] |\n| Chinese Simplified |    简体中文     |    zh     |          CN          | [zh-CN.ts][locale-zh-cn-url] |\n\n## 🔗 Related\n\n- [neofetch-themes][neofetch-themes-url] - Neofetch configs put into a convinient repository.\n- [NeoCat][neocat-url] - NeoFetch Theme Pack.\n\n## 🤝 Contribution\n\nContributions via Pull Requests or [Issues][issues-url] are welcome.\n\n## 📄 License\n\nThis project is licensed under the MIT License. See the [LICENSE][license-url] file for details.\n\n\n[node-image]: https://img.shields.io/node/v/%40kabeep%2Fneoconfig?color=lightseagreen\n[node-url]: https://nodejs.org/\n\n[npm-image]: https://img.shields.io/npm/d18m/%40kabeep%2Fneoconfig?color=fa6673\n[npm-url]: https://www.npmjs.com/package/@kabeep/neoconfig\n\n[install-size-image]: https://packagephobia.com/badge?p=@kabeep/neoconfig\n[install-size-url]: https://packagephobia.com/result?p=@kabeep/neoconfig\n\n[code-style-image]: https://img.shields.io/badge/Formatted_with-Biome-cornflowerblue?style=flat\u0026logo=biome\n[code-style-url]: https://biomejs.dev/\n\n[license-image]: https://img.shields.io/github/license/kabeep/neoconfig?color=slateblue\n[license-url]: LICENSE\n\n[en-us-url]: README.md\n[zh-cn-url]: README.zh-CN.md\n\n[locale-en-us-url]: src/locale/en-US.ts\n[locale-zh-cn-url]: src/locale/zh-CN.ts\n\n[neofetch-url]: https://github.com/dylanaraps/neofetch\n[nerd-url]: https://www.nerdfonts.com/font-downloads\n[neofetch-themes-url]: https://github.com/Chick2D/neofetch-themes\n[neocat-url]: https://github.com/m3tozz/NeoCat\n\n[issues-url]: https://github.com/kabeep/neoconfig/issues\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkabeep%2Fneoconfig","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkabeep%2Fneoconfig","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkabeep%2Fneoconfig/lists"}