The official CLI for your TSCord application!
npm install -g tscord-cli
tscord --help
The easiest way to get started with TSCord is by using the init command. It'll enable you to quickly start building a new TSCord application, with everything set up for you.
info For the moment, only the
bottemplate can be init with the CLI.
tscord init bot <name>
Display info about your TSCord project.
tscord info
You can generate every type of file needed in a TSCord bot application using the CLI in order to speed up your development process.
info The CLI auto-detects your current TSCord version and adapts the generated files to this version. Just keep in mind to update the CLI if you want to generate files for a brand new version prior to when you've installed the CLI.
First, run the command:
tscord generate
Then, choose the type of file you want and finally answer the extra questions depending on the file type.
You can also shortcut it by running:
tscord generate <type>
directly.
At some point you'll probably need to customize the generation CLI in different ways, for example:
It can be achieved by extracting it in your local project!
Simply run this command:
tscord generate --extract
and the source code will be copied in the root of your tscord project under the cli folder.
This part of the CLI is using plop.js under the hood, so we highly recommend you to check their documentation so you can understand and customize efficiently the generators/templates for your unique needs!
Plugins are hosted on the barthofu/tscord-plugins github repository. The CLI let you manage them in many ways!
note When we talk about plugin name, it is in fact their folder name which also acts as their unique identifier.
Use the plugin install command to install a plugin locally.
tscord plugin install <name>
Use the plugin uninstall command to uninstall a plugin locally.
tscord plugin uninstall <name>
Updating a plugin is done with the plugin update command.
tscord plugin update <name>
You can search for plugins and have info on them with the plugin search command.
tscord plugin search <query>
Options:
-l, --limit <number> limit the number of results (default: "10")-s, --short speed up search command by not showing extra information on pluginsThe plugin info command show you all the information about a plugin.
tscord plugin info <name>
FAQs
A fully-featured discord bot template written in Typescript, intended to provide a framework that's easy to use, extend and modify
The npm package tscord receives a total of 7 weekly downloads. As such, tscord popularity was classified as not popular.
We found that tscord demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.