cloud - GitLite

KO | EN

gitlite — search

#javascript #go #android #machine-learning #linux #docker #macos #nodejs #windows #vue #awesome-list #pytorch #mcp #ios

cloud

(★ 542)

Command framework & dispatcher for the JVM

File Explorer

Download Latest Version (.zip)

- checkstyle-suppressions.xml
- checkstyle.xml
- - build.yml
  - dependency_submission.yml
  - test_results.yml
- FUNDING.yml
- revapi.yml
- cloud.importorder
- build.gradle.kts
- build.gradle.kts
- build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- build.gradle.kts
- README.md
- - build.gradle.kts
  - settings.gradle.kts
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- libs.versions.toml
- - annotations_java_dark.png
  - annotations_java_light.png
  - annotations_kotlin_dark.png
  - annotations_kotlin_light.png
  - builder_java_dark.png
  - builder_java_light.png
  - builder_kotlin_dark.png
  - builder_kotlin_light.png
- cloud.png
- cloud.svg
- cloud_spooky.png
- CloudNew.png
- CloudNew.svg
.editorconfig
.gitattributes
.gitignore
build.gradle.kts
CHANGELOG.md
cloud_logo.png
CODE_OF_CONDUCT.md
CONTRIBUTING.md
gradle.properties
gradlew
gradlew.bat
HEADER
LICENSE
README.md
renovate.json
settings.gradle.kts

# Installation Guide

1. Get the code

git clone https://github.com/Incendo/cloud

Downloads the entire project code from GitHub to your computer.

cd cloud

Moves into the project folder you just downloaded.

2. Gradle (Java/Kotlin)

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
<img src="img/CloudNew.png" width="300px"/>
<br/>
<h1>cloud command framework</h1>

![license](https://img.shields.io/github/license/incendo/cloud.svg)
[![central](https://img.shields.io/maven-central/v/org.incendo/cloud-core)](https://search.maven.org/search?q=org.incendo)
![build](https://img.shields.io/github/actions/workflow/status/incendo/cloud/build.yml?logo=github)
[![docs](https://img.shields.io/readthedocs/incendocloud?logo=readthedocs)](https://cloud.incendo.org)
</div>

> [!NOTE]
> Cloud 2 is a major update with many significant changes. Cloud 2 is _not_ compatible with version 1.
> You can find the changelog [here](https://cloud.incendo.org/cloud-v2/).

Cloud is a general-purpose Java command dispatcher &amp; framework. It allows programmers to define command chains that are then parsed and invoked from user-supplied string inputs, to execute pre-defined actions.

Cloud commands consist out of deterministic chains of strongly typed arguments. When you define a command,
you know exactly what type of data you're going to be working with, and you know that there will be no
ambiguity at runtime. Cloud promotes writing reusable code, making it very easy to define new commands.

Cloud allows you to build commands in many different ways, according to your preferences:

<div align="center">
<picture>
    <source media="(prefers-color-scheme: dark)" srcset="img/code/builder_java_dark.png">
    <source media="(prefers-color-scheme: light)" srcset="img/code/builder_java_light.png">
    <img src="img/code/builder_java_light.png">
</picture>

<picture>
    <source media="(prefers-color-scheme: dark)" srcset="img/code/builder_kotlin_dark.png">
    <source media="(prefers-color-scheme: light)" srcset="img/code/builder_kotlin_light.png">
    <img src="img/code/builder_kotlin_light.png">
</picture>

<picture>
    <source media="(prefers-color-scheme: dark)" srcset="img/code/annotations_java_dark.png">
    <source media="(prefers-color-scheme: light)" srcset="img/code/annotations_java_light.png">
    <img src="img/code/annotations_java_light.png">
</picture>

<picture>
    <source media="(prefers-color-scheme: dark)" srcset="img/code/annotations_kotlin_dark.png">
    <source media="(prefers-color-scheme: light)" srcset="img/code/annotations_kotlin_light.png">
    <img src="img/code/annotations_kotlin_light.png">
</picture>
</div>

Cloud is built to be very customisable, in order to fit your needs. You can inject handlers and processors
along the entire command chain. If the pre-existing command parsers aren't enough for your needs, you're easily
able to create your own parsers. If you use the annotation parsing system, you can also define your own annotations
and register them to further customise the behaviour of the library.

Cloud by default ships with implementations and mappings for the most common Minecraft server platforms, 
Discord4J, JDA4, JDA5, Kord and Javacord for
Discord bots, PircBotX for IRC and [cloud-spring](https://github.com/incendo/cloud-spring) for Spring Shell.
The core module allows you to use Cloud anywhere, simply by implementing the CommandManager for the platform of your choice.

## links

- JavaDoc: https://javadoc.io/doc/org.incendo
- Docs: https://cloud.incendo.org
- Incendo Discord: https://discord.gg/aykZu32

### repositories

- [cloud](https://github.com/incendo/cloud) - main repository
- [cloud-minecraft](https://github.com/incendo/cloud-minecraft) - cloud implementations for minecraft
- [cloud-minecraft-modded](https://github.com/incendo/cloud-minecraft-modded) - cloud implementations for modded minecraft
- [cloud-discord](https://github.com/incendo/cloud-discord) - cloud implementations for discord
- [cloud-spring](https://github.com/incendo/cloud-spring) - cloud implementation for spring-shell
- [cloud-processors](https://github.com/incendo/cloud-processors) - extra pre- & postprocessors
- [cloud-build-logic](https://github.com/incendo/cloud-build-logic) - gradle plugin for building cloud
- [cloud-docs](https://github.com/incendo/cloud-docs) - documentation sources
  
## develop &amp; build  
  
To clone the repository, use `git clone https://github.com/Incendo/cloud.git`.

To then build it, use `./gradlew clean build`. If you want to build the examples as well, use `./gradlew clean build
-Pcompile-examples`.

## attributions, links &amp; acknowledgements  
  
This library is licensed under the <a href="https://opensource.org/licenses/MIT">MIT</a> license, and the code copyright  belongs to Alexander Söderberg. The implementation is based on a paper written by the copyright holder, and this paper exists under the <a href="https://creativecommons.org/licenses/by/4.0/legalcode">CC Attribution 4</a> license.  
  
The <a href="https://iconscout.com/icons/cloud" target="_blank">Cloud</a> icon was created by <a href="https://iconscout.com/contributors/oviyan">
Thanga Vignesh P</a> on <a href="https://iconscout.com">Iconscout</a> and Digital rights were purchased under a premium plan.