Carbon CLI

The Carbon CLI provides a powerful command-line interface for managing your Minecraft server hosting on the Carbon Host platform. Built with TypeScript, it offers commands for deploying files, watching for changes, and managing your deployed stars seamlessly.

Installation

To install the CLI, use bun as shown below:

bun add -g carbon-cli

Usage

Run the carbon command followed by the desired subcommand:

carbon <command>

Commands

• carbon deploy <source> <target> [post-deploy-command] Deploys a local file to your star.
• carbon watch <source> <target> [post-deploy-command] Watches a local file and deploys it to your star.
• carbon ls Lists your deployed stars.
• carbon set-key <apiKey> Sets your API key.

Options

• --help Show help [boolean]
• --version Show version number [boolean]
• -v, --verbose Enable verbose logging [boolean]
• --star The ID of the star to use [string]

You need to specify a command.

Documentation

For more detailed documentation, visit the Documentation page.

Support

If you encounter issues or have questions, please open an issue on our GitHub Issues page or join our Discord server.

License

This project is licensed under the GNU AGPL License.