diff --git a/docs/cli/clear.md b/docs/cli/clear.md new file mode 100644 index 000000000..f2e0cef8e --- /dev/null +++ b/docs/cli/clear.md @@ -0,0 +1,28 @@ +```sh +Usage: sern commands clear [options] + +Clear and reset commands-data-remote.json and the api + +Options: + -y, --yes Say yes to all prompts + -e, --env [path] Supply a path to a .env + -h, --help display help for command +``` +## Implicits +- Automatically reads a .env in the working directory. For seamless integration, your .env file should look like this: +```txt title=".env" +DISCORD_TOKEN= +APPLICATION_ID= +NODE_ENV= +``` +- Calls the discord API with the [PUT route](https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands) with an EMPTY array, essentially setting all registered commands to nothing. + +- Optionally override an .env path as a command line argument as well. **CLI arguments take precedence.** +If you do not know how to obtain either of these credentials, [click here](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token) + +- Automatically confirm with the **-y** flag. + +## Features +- Clears all application data and sern-commands-data.json + + diff --git a/docs/cli/publish.md b/docs/cli/publish.md index 6d850d307..e4a8c3781 100644 --- a/docs/cli/publish.md +++ b/docs/cli/publish.md @@ -17,7 +17,7 @@ Options: ```txt title=".env" DISCORD_TOKEN= APPLICATION_ID= -MODE= +NODE_ENV= ``` - Calls the discord API with the [PUT route](https://discord.com/developers/docs/interactions/application-commands#bulk-overwrite-global-application-commands). Wherever your commands directory is located, publish will override the existing application commands at Discord. Existing commands do not count towards the command limit creation daily.