> For the complete documentation index, see [llms.txt](https://docs.rumi.systems/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rumi.systems/rumi-cli/commands/cloud/local.md).

# local

The `rumi cloud local` commands provision and manage a Docker-based **Rumi private cloud** on your local machine.

## Overview

The local environment provides a **complete Rumi private cloud** running in Docker containers. This private cloud has the **exact same structure** as production private clouds deployed to AWS, Civo, bare metal, or other infrastructure - just containerized locally.

### Private Cloud Components

* **Admin** - Administrative interface and deployment management
* **Agent** - Monitoring and management agent
* **Monitor** - Observability dashboards and metrics
* **Message Broker** - Solace, Kafka, or ActiveMQ
* **Platform Modules** - Core Rumi runtime services
* **Application Services** - Your deployed Rumi microservices

**Key Concept:** By developing locally, you're working with the same standardized private cloud architecture used in production, ensuring your applications will behave identically when deployed to other environments.

## Commands

### Environment Management

| Command                                                      | Description                                   |
| ------------------------------------------------------------ | --------------------------------------------- |
| [provision](/rumi-cli/commands/cloud/local/provision.md)     | Provision the local private cloud environment |
| [start](/rumi-cli/commands/cloud/local/start.md)             | Start all services                            |
| [stop](/rumi-cli/commands/cloud/local/stop.md)               | Stop all services                             |
| [deprovision](/rumi-cli/commands/cloud/local/deprovision.md) | Remove the environment                        |

### Admin Module

| Command                                                                | Description                          |
| ---------------------------------------------------------------------- | ------------------------------------ |
| [launch-admin](/rumi-cli/commands/cloud/local/launch-admin.md)         | Provision and start the admin module |
| [start-admin](/rumi-cli/commands/cloud/local/start-admin.md)           | Start the admin module               |
| [stop-admin](/rumi-cli/commands/cloud/local/stop-admin.md)             | Stop the admin module                |
| [terminate-admin](/rumi-cli/commands/cloud/local/terminate-admin.md)   | Remove the admin module              |
| [run-admin-script](/rumi-cli/commands/cloud/local/run-admin-script.md) | Execute an admin script              |

### Monitor Module

| Command                                                                  | Description                            |
| ------------------------------------------------------------------------ | -------------------------------------- |
| [launch-monitor](/rumi-cli/commands/cloud/local/launch-monitor.md)       | Provision and start the monitor module |
| [start-monitor](/rumi-cli/commands/cloud/local/start-monitor.md)         | Start the monitor module               |
| [stop-monitor](/rumi-cli/commands/cloud/local/stop-monitor.md)           | Stop the monitor module                |
| [terminate-monitor](/rumi-cli/commands/cloud/local/terminate-monitor.md) | Remove the monitor module              |

### Message Brokers

| Command                                                                | Description                  |
| ---------------------------------------------------------------------- | ---------------------------- |
| [launch-solace](/rumi-cli/commands/cloud/local/launch-solace.md)       | Provision and start Solace   |
| [start-solace](/rumi-cli/commands/cloud/local/start-solace.md)         | Start Solace                 |
| [stop-solace](/rumi-cli/commands/cloud/local/stop-solace.md)           | Stop Solace                  |
| [terminate-solace](/rumi-cli/commands/cloud/local/terminate-solace.md) | Remove Solace                |
| [launch-kafka](/rumi-cli/commands/cloud/local/launch-kafka.md)         | Provision and start Kafka    |
| [start-kafka](/rumi-cli/commands/cloud/local/start-kafka.md)           | Start Kafka                  |
| [stop-kafka](/rumi-cli/commands/cloud/local/stop-kafka.md)             | Stop Kafka                   |
| [terminate-kafka](/rumi-cli/commands/cloud/local/terminate-kafka.md)   | Remove Kafka                 |
| [launch-amq](/rumi-cli/commands/cloud/local/launch-amq.md)             | Provision and start ActiveMQ |
| [start-amq](/rumi-cli/commands/cloud/local/start-amq.md)               | Start ActiveMQ               |
| [stop-amq](/rumi-cli/commands/cloud/local/stop-amq.md)                 | Stop ActiveMQ                |
| [terminate-amq](/rumi-cli/commands/cloud/local/terminate-amq.md)       | Remove ActiveMQ              |

### Platform Modules

| Command                                                                    | Description                          |
| -------------------------------------------------------------------------- | ------------------------------------ |
| [launch-platform](/rumi-cli/commands/cloud/local/launch-platform.md)       | Provision and start platform modules |
| [start-platform](/rumi-cli/commands/cloud/local/start-platform.md)         | Start platform modules               |
| [stop-platform](/rumi-cli/commands/cloud/local/stop-platform.md)           | Stop platform modules                |
| [terminate-platform](/rumi-cli/commands/cloud/local/terminate-platform.md) | Remove platform modules              |

### Service Instances

| Command                                                                    | Description                            |
| -------------------------------------------------------------------------- | -------------------------------------- |
| [launch-instance](/rumi-cli/commands/cloud/local/launch-instance.md)       | Provision and start a service instance |
| [start-instance](/rumi-cli/commands/cloud/local/start-instance.md)         | Start a service instance               |
| [stop-instance](/rumi-cli/commands/cloud/local/stop-instance.md)           | Stop a service instance                |
| [terminate-instance](/rumi-cli/commands/cloud/local/terminate-instance.md) | Remove a service instance              |
| [list-instances](/rumi-cli/commands/cloud/local/list-instances.md)         | List all containers                    |
| [run-command](/rumi-cli/commands/cloud/local/run-command.md)               | Execute a command on a container       |

### Deployment

| Command                                                  | Description               |
| -------------------------------------------------------- | ------------------------- |
| [deploy](/rumi-cli/commands/cloud/local/deploy.md)       | Deploy a Rumi application |
| [configure](/rumi-cli/commands/cloud/local/configure.md) | Update configuration      |

## Prerequisites

Before using local cloud commands:

1. **Docker Desktop** must be installed and running
2. **Sufficient resources**: 8GB+ RAM, 20GB+ disk space
3. **Network ports**: Ensure required ports are available

See [Installation](/rumi-cli/installation.md) for Docker setup instructions.

## Typical Workflow

```bash
# 1. Provision environment with a message broker
rumi cloud local provision --message-broker activemq

# 2. Deploy your application
rumi cloud local deploy --xar my-app.xar

# 3. Start everything
rumi cloud local start

# 4. Stop when done
rumi cloud local stop

# 5. Clean up
rumi cloud local deprovision
```

## Related Documentation

* [**Installation**](/rumi-cli/installation.md) - Install the Rumi CLI and Docker
* [**Quickstart**](/rumi-cli/commands/quickstart.md) - Generate applications to deploy
* [**AWS Commands**](/rumi-cli/commands/cloud/aws.md) - Deploy to AWS


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.rumi.systems/rumi-cli/commands/cloud/local.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.