Overview

The @sodacore/cli package is a standalone command line tool for interacting with your Sodacore applications. It allows you to run your defined scripts, execute tasks, and see logging and performance information.

• Installation
• Usage
• Commands

Installation

To install the CLI, you can use the following command:

bun install --global sodacore

This will expose the sodacore command globally, allowing you to run it from anywhere.

Usage

To use the CLI, you can simply run the CLI command:

sodacore

The CLI can add/remove connections to your applications, this works by using the given interface options.

Once you have added a connection, you can use the Access command to connect to your instance, and then run your commands.

All plugins may include their own commands, for example, in the Discord plugin, we expose controls for registering and unregistering the slash commands.

Each plugin should note their exposed scripts.

Commands

The CLI acts as an interface to your Sodacore application, while your application is running, you can tell it to run commands, these could be anything from running tasks, or interacting with other plugins.

Each plugin may expose it's own commands, for example, the Discord plugin exposes commands for registering and unregistering slash commands either globally or to a specific guild, alternatively the core package exposes a few commands, i.e. for running tasks, viewing logs, etc.