{"id":21044381,"url":"https://github.com/ashikka/winx","last_synced_at":"2025-08-22T01:23:04.903Z","repository":{"id":50012293,"uuid":"368985541","full_name":"ashikka/winx","owner":"ashikka","description":"A CLI to generate CLIs","archived":false,"fork":false,"pushed_at":"2021-06-06T05:49:39.000Z","size":188,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-08T00:09:09.028Z","etag":null,"topics":["cli","development-tools","devtool","generator","nodejs","npm-package"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/winx","language":"JavaScript","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/ashikka.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-19T19:52:18.000Z","updated_at":"2024-04-30T11:17:14.000Z","dependencies_parsed_at":"2022-08-02T14:15:38.835Z","dependency_job_id":null,"html_url":"https://github.com/ashikka/winx","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":"csivitu/Template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashikka%2Fwinx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashikka%2Fwinx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashikka%2Fwinx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ashikka%2Fwinx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ashikka","download_url":"https://codeload.github.com/ashikka/winx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225365721,"owners_count":17462973,"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","development-tools","devtool","generator","nodejs","npm-package"],"created_at":"2024-11-19T14:16:35.975Z","updated_at":"2024-11-19T14:16:36.672Z","avatar_url":"https://github.com/ashikka.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![csivit][csivitu-shield]][csivitu-url]\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n[![Issues][issues-shield]][issues-url]\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://imgbb.com/\"\u003e\u003cimg src=\"https://i.ibb.co/K9BwvSZ/Screenshot-from-2021-05-24-15-20-01.png\" alt=\"Screenshot-from-2021-05-24-15-20-01\" border=\"0\"\u003e\u003c/a\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003ewinx\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    A CLI to generate CLIs\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/csivitu/Template\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/csivitu/Template\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/csivitu/Template/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/csivitu/Template/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n## Table of Contents\n\n* [About the Project](#about-the-project)\n  * [Built With](#built-with)\n* [Getting Started](#getting-started)\n  * [Prerequisites](#prerequisites)\n  * [Installation](#installation)\n* [Usage](#usage)\n* [Roadmap](#roadmap)\n* [Contributing](#contributing)\n* [License](#license)\n* [Contributors](#contributors-)\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://imgbb.com/\"\u003e\u003cimg src=\"https://i.ibb.co/K7yK5Sk/Screenshot-from-2021-05-24-15-22-18.png\" alt=\"Screenshot-from-2021-05-24-15-22-18\" border=\"0\"\u003e\u003c/a\u003e\n\u003ca href=\"https://ibb.co/y00ND6P\"\u003e\u003cimg src=\"https://i.ibb.co/VVVLdg9/Screenshot-from-2021-05-24-15-24-11.png\" alt=\"Screenshot-from-2021-05-24-15-24-11\" border=\"0\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n**winx** is a development tool created to speed up your CLI development,so that you don't need to setup up your CLI project. It comes with well-defined directories and files, with all the packages needed installed, and pre-made config files to, so that you don't need to go through the painstaking process of setting up everything. \n\n\n### Built With\n\n* [yargs](https://www.npmjs.com/package/yargs)\n* [fs-extra](https://www.npmjs.com/package/fs-extra)\n* [boxen](https://www.npmjs.com/package/boxen)\n* [chalk](https://www.npmjs.com/package/chalk)\n\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nTo get a local copy up and running follow these simple steps.\n\n### Prerequisites\n\nThis is an example of how to list things you need to use the software and how to install them.\n* npm\n```sh\nnpm install npm@latest -g\n```\n\n### Installation\n\nEither through cloning with git or by using npm (the recommended way):\n\n1. Install NPM packages\n```sh\nnpm install -g winx\n```\nAnd winx will be installed globally to your system path.\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\nTo check if installation was successful, use the command: \n\n```\nwinx --version\n```\nThis will display the latest version. \n\nAfter installation, run the command below in your terminal:\n\n```\nwinx --help \n```\nThe help menu with all the options will be listed. \n\nTo create your own cli, use the command: \n\n```\nwinx \u003cyou-cli\u003e \u003cpath\u003e\n```\n`\u003cyour-cli\u003e` argument takes the CLI's name  and `\u003cpath\u003e` take the preferred path you want the CLI directory to be generated at on your local system. If no path is specified then the CLI will be generated in your current directory. \n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\nSee the [open issues](https://github.com/csivitu/Template/issues) for a list of proposed features (and known issues).\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'feat: Add some AmazingFeature'`)\n4. Push to the Branch (`git push -u origin feature/AmazingFeature`)\n5. Open a Pull Request\n\nYou are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) while contributing to the project :smile:.\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.\n\n\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[csivitu-shield]: https://img.shields.io/badge/csivitu-csivitu-blue\n[csivitu-url]: https://csivit.com\n[issues-shield]: https://img.shields.io/github/issues/csivitu/Template.svg?style=flat-square\n[issues-url]: https://github.com/csivitu/Template/issues\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/ashikka\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/58368421?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAshikka Gupta\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/ashikka/winx/commits?author=ashikka\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/ashikka/winx/commits?author=ashikka\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fashikka%2Fwinx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fashikka%2Fwinx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fashikka%2Fwinx/lists"}