/djs-template-cli

๐Ÿ“ฆ [Archived] Easy way to create new discord.js project

Primary LanguageTypeScriptMIT LicenseMIT

๐Ÿค– djs-template-cli

NPM banner

NPM version NPM downloads

โžก๏ธ Usage

๐Ÿ“ฆ Install this package

sudo may required for UNIX-based system

๐Ÿ“ฆ npm

$ npm install -g djs-template-cli
#
# added ??? packages, and audited ??? packages in 2.35s
# found 0 vulnerabilities

๐Ÿˆ yarn

$ yarn global add djs-template-cli
#
# yarn global v1.22.xx
# [1/4] ๐Ÿ”  Resolving packages...
# [2/4] ๐Ÿšš  Fetching packages...
# [3/4] ๐Ÿ”—  Linking dependencies...
# [4/4] ๐Ÿ”จ  Building fresh packages...
#
# success Installed "djs-template-cli" with binaries:
#       - djs-cli
#       - discord.js-cli
# โœจ  Done in 1s.

๐Ÿƒ Start creating new project

$ djs-cli [OPTIONS...]
# or
$ discord.js-cli [OPTIONS...]

Notice : This package will create a project inside your current working directory (pwd). To avoid creating a project in wrong directory (ex: in your /home/user directory), create an empty directory, change dir to newly created directory, and run the main binary

๐Ÿ“š Options

Available options for this package. If no options are used, a user interface prompt will show up instead

Options Description Default
javascript Create JavaScript-based discord.js project true
typescript Create TypeScript-based discord.js project false
-g, --git Initialize Git inside the project false
-i, --install Install required dependecies when creating a project false
-y, --yes Skip prompt and use default option false

๐Ÿท๏ธ Discord.js version

  • JavaScript Template uses Discord.js version : 13.8.1
  • TypeScript Template uses Discord.js version : 13.8.1

๐Ÿ‘จโ€๐Ÿ’ป Contributing

Contributions are welcome! Feel free to submit a Pull Request with improvements!

๐Ÿงพ License

djs-template-cli is Licensed Under MIT License.