mirror of
https://github.com/sern-handler/cli
synced 2026-06-06 01:16:53 +00:00
61 lines
1.6 KiB
Markdown
61 lines
1.6 KiB
Markdown
# Sern CLI
|
|
|
|
Our CLI allows you to setup and manage Discord bot projects without writing a single line of code!
|
|
|
|
😁 **User Friendly** <br>
|
|
💦 **Simple** <br>
|
|
🌱 **Efficient** <br>
|
|
💪 **Powerful** <br>
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
npm install -g @sern/cli@latest
|
|
```
|
|
|
|
```sh
|
|
yarn add -g @sern/cli@latest
|
|
```
|
|
|
|
```sh
|
|
pnpm add -g @sern/cli@latest
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
When you install the CLI, you can use our commands with **sern** prefix.
|
|
|
|
```
|
|
Usage: sern [options] [command]
|
|
|
|
Welcome to Sern!
|
|
If you're new to Sern, run sern init for an interactive setup to your new bot project!
|
|
|
|
If you have any ideas, suggestions, bug reports, kindly join our support server: https://discord.gg/xzK5fUKT4r
|
|
|
|
Options:
|
|
-V, --version output the version number
|
|
-h, --help display help for command
|
|
|
|
Commands:
|
|
init [options] Quickest way to scaffold a new project
|
|
plugins [options] Install plugins from https://github.com/sern-handler/awesome-plugins
|
|
extra Easy way to add extra things in your sern project
|
|
help [command] display help for command
|
|
|
|
```
|
|
|
|
## Setting Up Your Project
|
|
|
|
Run `sern init (-y)` for an interactive setup on a brand new project using our framework. <br>
|
|
Adding the `-y` flag sets up project as default. ( **Note** : the default initiates a typescript project)
|
|
|
|
## Installing Plugins
|
|
|
|
Sern runs on your plugins. Contribute to the [repository](https://github.com/sern-handler/awesome-plugins) and then install the plugins via our cli! <br>
|
|
Run `sern plugins` to see all installable options
|
|
|
|
## Stats
|
|
|
|
|