> 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.md).

# Commands

This section provides detailed reference documentation for all Rumi CLI commands.

## Command Hierarchy

```
rumi
├── version
├── quickstart
│   ├── app
│   ├── processor
│   ├── driver
│   └── csvwriter
├── cloud
│   ├── local
│   │   ├── provision
│   │   ├── start
│   │   ├── stop
│   │   ├── deprovision
│   │   ├── launch-admin
│   │   ├── start-admin
│   │   ├── stop-admin
│   │   ├── terminate-admin
│   │   ├── run-admin-script
│   │   ├── launch-monitor
│   │   ├── start-monitor
│   │   ├── stop-monitor
│   │   ├── terminate-monitor
│   │   ├── launch-solace
│   │   ├── start-solace
│   │   ├── stop-solace
│   │   ├── terminate-solace
│   │   ├── launch-kafka
│   │   ├── start-kafka
│   │   ├── stop-kafka
│   │   ├── terminate-kafka
│   │   ├── launch-amq
│   │   ├── start-amq
│   │   ├── stop-amq
│   │   ├── terminate-amq
│   │   ├── launch-platform
│   │   ├── start-platform
│   │   ├── stop-platform
│   │   ├── terminate-platform
│   │   ├── launch-instance
│   │   ├── start-instance
│   │   ├── stop-instance
│   │   ├── terminate-instance
│   │   ├── list-instances
│   │   ├── run-command
│   │   ├── deploy
│   │   └── configure
│   └── aws
│       ├── create-network
│       ├── list-networks
│       ├── delete-network
│       ├── create-zone
│       ├── list-zones
│       ├── launch-jump
│       ├── start-jump
│       ├── stop-jump
│       ├── terminate-jump
│       ├── launch-admin
│       ├── start-admin
│       ├── stop-admin
│       ├── terminate-admin
│       ├── run-admin-script
│       ├── launch-monitor
│       ├── start-monitor
│       ├── stop-monitor
│       ├── terminate-monitor
│       ├── launch-solace
│       ├── start-solace
│       ├── stop-solace
│       ├── terminate-solace
│       ├── launch-kafka
│       ├── start-kafka
│       ├── stop-kafka
│       ├── terminate-kafka
│       ├── launch-platform
│       ├── start-platform
│       ├── stop-platform
│       ├── terminate-platform
│       ├── launch-instance
│       ├── start-instance
│       ├── stop-instance
│       ├── terminate-instance
│       ├── list-instances
│       ├── attach-volume
│       ├── run-command
│       ├── provision
│       ├── deploy
│       ├── configure
│       ├── start
│       ├── stop
│       └── deprovision
├── dev
└── tools
    ├── admin
    ├── discovery
    ├── hbdump
    ├── tlt
    ├── latreport
    └── txnstats
        ├── dump
        └── query
```

## Command Structure

Rumi CLI commands follow this pattern:

```bash
rumi [global-flags] <command> [subcommand] [options]
```

## Global Flags

The following flags can be used with any `rumi` command:

| Flag                  | Description                                                                                                                                          |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--help`, `-h`        | Display help for any command. Works at every level: `rumi --help`, `rumi cloud --help`, `rumi cloud aws provision --help`, etc.                      |
| `--3x`                | Enable X Platform 3.x compatibility mode. Required when working with X Platform 3.x logs, containers (XVMs), or any 3.x artifacts or components.     |
| `--extra-jars <jars>` | Comma-separated list of additional JAR files to add to the classpath. Useful for loading application-specific message factories when analyzing logs. |

**Examples:**

```bash
# Process a log file from an X Platform 3.x application
rumi --3x tools tlt /path/to/3x-app.log

# Load application JARs for log analysis
rumi --extra-jars /path/to/app.jar,/path/to/models.jar tools tlt /path/to/app.log

# Combine flags
rumi --3x --extra-jars /path/to/app.jar tools txnstats dump -l /path/to/app.txnstats.log
```

## Environment Variables

| Variable             | Description                                                                         |
| -------------------- | ----------------------------------------------------------------------------------- |
| `RUMI_CLI_JAVA_HOME` | Path to a Java 11+ installation. Used if `java` on PATH is missing or too old.      |
| `JAVA_OPTS`          | Additional JVM options to pass to the CLI. Cannot override required internal flags. |

**Examples:**

```bash
# Specify Java installation
export RUMI_CLI_JAVA_HOME=/usr/lib/jvm/java-11-openjdk

# Increase heap size for large log files
export JAVA_OPTS="-Xmx4g"
rumi tools tlt /path/to/large.log
```

## Top-Level Commands

| Command                                        | Description                                         |
| ---------------------------------------------- | --------------------------------------------------- |
| [version](/rumi-cli/commands/version.md)       | Print the installed CLI version                     |
| [quickstart](/rumi-cli/commands/quickstart.md) | Generate Rumi applications and services             |
| [cloud](/rumi-cli/commands/cloud.md)           | Provision and manage cloud deployments              |
| [dev](/rumi-cli/commands/dev.md)               | Application development commands *(in development)* |
| [tools](/rumi-cli/commands/tools.md)           | Analyze logs and troubleshoot applications          |

## Quickstart Commands

Generate complete Rumi applications and individual services.

| Command                                                 | Description                                          |
| ------------------------------------------------------- | ---------------------------------------------------- |
| [app](/rumi-cli/commands/quickstart/app.md)             | Generate complete application with multiple services |
| [processor](/rumi-cli/commands/quickstart/processor.md) | Generate stateful processor service                  |
| [driver](/rumi-cli/commands/quickstart/driver.md)       | Generate message driver service                      |
| [csvwriter](/rumi-cli/commands/quickstart/csvwriter.md) | Generate CSV writer service                          |

**Example:**

```bash
rumi quickstart app --messaging-provider activemq
```

## Cloud Commands

Provision and manage **Rumi private clouds** - a standardized deployment architecture consisting of platform services (Admin, Monitor, Messaging) and your application services.

| Environment                                | Description                        |
| ------------------------------------------ | ---------------------------------- |
| [local](/rumi-cli/commands/cloud/local.md) | Docker-based on your local machine |
| [aws](/rumi-cli/commands/cloud/aws.md)     | Amazon Web Services                |

**Key benefit:** The same architecture works identically across all environments.

**Example workflow:**

```bash
# Provision with ActiveMQ
rumi cloud local provision --message-broker activemq

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

# Start environment
rumi cloud local start
```

## Tools Commands

Tools for analyzing, troubleshooting, and maintaining Rumi applications.

| Tool                                               | Description                                        |
| -------------------------------------------------- | -------------------------------------------------- |
| [admin](/rumi-cli/commands/tools/admin.md)         | Administrative CLI for running containers          |
| [discovery](/rumi-cli/commands/tools/discovery.md) | Diagnose discovery issues                          |
| [hbdump](/rumi-cli/commands/tools/hbdump.md)       | Extract heartbeats from logs                       |
| [tlt](/rumi-cli/commands/tools/tlt.md)             | Query and analyze transaction logs                 |
| [latreport](/rumi-cli/commands/tools/latreport.md) | Generate latency reports from binary latency files |
| [txnstats](/rumi-cli/commands/tools/txnstats.md)   | Analyze per-transaction timing statistics          |

**Example:**

```bash
# Query transaction log
rumi tools tlt /path/to/app.log

# Check recent heartbeats
rumi tools hbdump /path/to/app.log --startDate "2025-01-04 10:00:00"
```

## Getting Help

You can get help for any command using `--help` (or `-h`):

```bash
# General help
rumi --help

# Command-specific help
rumi quickstart --help
rumi cloud local --help
rumi tools tlt --help
rumi cloud aws provision --help
rumi tools txnstats dump --help
```

The `rumi help` command also works:

```bash
rumi help
rumi help quickstart
rumi help cloud local
rumi help tools tlt
```

## Related Documentation

* [**What is the CLI**](/rumi-cli/what-is-the-cli.md) - Overview and installation
* [**Installation**](/rumi-cli/installation.md) - Install and configure the CLI


---

# 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:

```
GET https://docs.rumi.systems/rumi-cli/commands.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.