{"id":14983495,"url":"https://github.com/sheweny/cli","last_synced_at":"2025-10-29T22:30:42.301Z","repository":{"id":36977863,"uuid":"397488460","full_name":"Sheweny/cli","owner":"Sheweny","description":"Cli of sheweny framework","archived":false,"fork":false,"pushed_at":"2023-08-03T03:59:10.000Z","size":935,"stargazers_count":4,"open_issues_count":8,"forks_count":4,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-01T03:11:21.322Z","etag":null,"topics":["cli","discord","discord-bot","discord-js","discordjs","framework","sheweny"],"latest_commit_sha":null,"homepage":"https://sheweny.js.org/guide/cli/Installation","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/Sheweny.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2021-08-18T05:52:49.000Z","updated_at":"2023-01-11T00:25:57.000Z","dependencies_parsed_at":"2024-11-10T23:31:19.499Z","dependency_job_id":"4858a715-079b-4d49-872f-87ee13a26c1d","html_url":"https://github.com/Sheweny/cli","commit_stats":{"total_commits":211,"total_committers":4,"mean_commits":52.75,"dds":0.5165876777251185,"last_synced_commit":"1d12cbcfcb2c6e32518360f021505c68f42ff019"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sheweny%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sheweny%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sheweny%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sheweny%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sheweny","download_url":"https://codeload.github.com/Sheweny/cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238900426,"owners_count":19549511,"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","discord","discord-bot","discord-js","discordjs","framework","sheweny"],"created_at":"2024-09-24T14:07:17.509Z","updated_at":"2025-10-29T22:30:41.788Z","avatar_url":"https://github.com/Sheweny.png","language":"TypeScript","readme":"# Sheweny CLI\r\n\r\n![sheweny_baniere (5)](https://user-images.githubusercontent.com/59796136/146163807-a14768d5-c8c9-4968-a55f-a19157cf6ead.png)\r\n\r\n[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/Sheweny/cli)\r\n[![made-with-Markdown](https://img.shields.io/badge/Made%20with-Typescript-1f425f.svg)](http://commonmark.org)\r\n[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/Sheweny/master/LICENSE)\r\n[![GitHub tag](https://img.shields.io/github/tag/Sheweny/cli.svg)](https://github.com/Sheweny/cli/tags/)\r\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\r\n\r\nThis module is a CLI (Command Line Interface) for create discord bots with Sheweny framework.\r\n\r\n**Guide : [Click here](https://sheweny.js.org/guide/cli/Usage.html)**\r\n\r\n- [Sheweny](#sheweny-cli)\r\n- [Getting started](#getting-started-)\r\n  - [Prerequisites](#prerequisites-)\r\n  - [Installation](#installation-)\r\n- [Usage](#usage-)\r\n  - [Informations](#informations-)\r\n  - [Create command](#create-command-)\r\n  - [Add command](#add-command-)\r\n  - [Init command](#init-command-)\r\n  - [Version command](#version-command-)\r\n- [Common errors](#common-errors-%EF%B8%8F)\r\n- [Contributions/Licence](#contributionslicence-)\r\n- [Help](#need-help-)\r\n\r\n## Getting started ✨\r\n\r\n### Prerequisites 👀\r\n\r\nNode.js 16.6.0 or newer is required.\r\n\r\n### Installation 🎈\r\n\r\nFor creating a discord bot project with the Sheweny framework, sheweny's command line interface will make your life easier.\r\nTo use it is very simple, you just need to have npm (or yarn), and to install the module.\r\n\r\nInstall with npm\r\n\r\n```sh\r\nnpm install -g @sheweny/cli\r\n```\r\n\r\nInstall with yarn\r\n\r\n```sh\r\nyarn global add @sheweny/cli\r\n```\r\n\r\nOnce the command line interface is installed, you can go to the next section to learn more about the different commands.\r\n\r\n## Usage 💡\r\n\r\n### Informations 📖\r\n\r\nThe command line interface has several prefixes which are `sheweny` and `shw`, so for the following commands, you can use one of the 2 prefixes.\r\nThe help command is also at your disposal if you are too lazy to come to the guide.\r\n\r\n```sh\r\nsheweny --help\r\n```\r\n\r\n### Create command ⛏️\r\n\r\nTo create a project, you just need to run the following command.\r\n\r\n```sh\r\nsheweny create [project_name]\r\n```\r\n\r\nThen you will have a series of questions that will allow you to refine the result of your project creation and to have a bot start that meets your expectations.\r\nDepending on what you have answered, you will have access from the start, the creation of the project has commands, events, or interactions.\r\n\r\nFor more information, you can run the help command: `sheweny --help create`\r\n\r\n### Add command 🔥\r\n\r\nTo add a template in your project with the sheweny framework, you just need to run the following command.\r\n\r\n```sh\r\nsheweny add\r\n```\r\n\r\nYou have several types of template addition depending on what you want to add\r\n\r\n- command\r\n- event\r\n- button\r\n- selectmenu\r\n- inhibitor\r\n\r\nAfter choosing the type of addition, you can answer the questions that are offered to once again refine the result of adding a template.\r\n\r\nFor more information, you can run the help command: `sheweny --help add`.\r\n\r\n### Init command 🏁\r\n\r\nThis command is used to initialize the Command Line Interface (CLI) with **an existing project** .\r\n\r\n### Version command 📈\r\n\r\nThis command return the version of the CLI (not the framework).\r\n\r\n---\r\n\r\nAfter having done all this, you can of course edit the project code as you wish with an editor, using the rest of the Guide or with the Documentation.\r\n\r\n## Common errors ☢️\r\n\r\n### Execution Policy 🔴\r\n\r\nIf you have an error :\r\n\r\n```sh\r\nFile cannot be loaded because the execution of scripts is disabled on this system. Please see \"get-help about_signing\" for more details\r\n```\r\n\r\nChanged script execution parameter. On an administrator powershell, you can do this by running the following command:\r\n\r\n```sh\r\nSet-ExecutionPolicy Unrestricted\r\n```\r\n\r\n## Contributions/Licence 🌍\r\n\r\nThis project has an MIT license. And you are welcome to contribute.\r\n\r\n## Need help 👍\r\n\r\nIf you have question or need help, open issue or join [support server](https://discord.gg/qgd85nEf5a).\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsheweny%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsheweny%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsheweny%2Fcli/lists"}