Solace TryMe CLI

Training, Tips and Tricks
,
1

:wrench: Meet solace-tryme-cli aka stm: Your Local Playground for Event Simulation with Solace Broker

:test_tube: What is solace-tryme-cli?

Want to explore Solace PubSub+ messaging without writing a single line of code? The solace-tryme-cli (aka stm) tool is your fastest path to hands-on experience with Solace messaging.

Designed for developers and architects, stm provides an intuitive command-line interface to send, receive, request, and reply to messages using a live Solace broker — making it perfect for quick experiments, debugging, and learning.

:light_bulb: What Can You Do with try-me?

Using a single CLI binary, you can:

  • :outbox_tray: Send messages to any topic
  • :inbox_tray: Receive messages using topic subscriptions
  • :repeat_button: Request a message and await a reply (request-reply)
  • :open_mailbox_with_raised_flag: Reply to incoming request messages

All without setting up producer/consumer applications or using an SDK.

That’s where stm shines: it generates event traffic based on the payload input you specify — supporting multiple options like a default payload, command-line value, file content, or interactive terminal input — with zero boilerplate. It sends the message directly to your Solace broker using the topic structure you define.

:gear: How It Works

The CLI is driven entirely by command-line arguments and values, making it fully scriptable and automation-friendly.

Here’s how it works:

  1. Specify your broker connection details
    Provide the host, username, and password for your Solace Cloud or local broker.
    2.(If not specified, it defaults to a standard local broker configuration.)*
  2. Choose a messaging action
    Use one of the supported actions: send, receive, request, or reply.
  3. Provide topic and message content
    Enter the topic to publish or subscribe to, and supply the message payload.
    Payloads can be passed as:
  • A predefined default
  • A command-line value
  • File content
  • Interactive terminal input

:rocket: Use Cases in the Real World

  • :white_check_mark: Quickly test and validate topic structures without writing code
  • :wrench: Simulate producer or consumer behavior during local development
  • :vertical_traffic_light: Run lightweight smoke tests in CI/CD pipelines
  • :graduation_cap: Deliver interactive demos or training sessions with real messaging
  • :scroll: Script message flows for automation or functional testing
  • :counterclockwise_arrows_button: Mock upstream/downstream systems in service integration scenarios

Each use case highlights stm’s simplicity and flexibility — making it a go-to utility for fast, real-world Solace messaging workflows.

:pushpin: Learn More

solace-tryme-cli is your Swiss Army knife for messaging simulation in Solace ecosystems. Whether you’re testing publish/subscribe flows or request-reply interactions, this CLI helps bring your Solace topics to life — instantly and effortlessly.

The stm tool supports a rich set of command-line parameters tailored to each operation (send, receive, request, or reply). You can find comprehensive documentation here:
:page_facing_up: stm messaging command-line parameters

Want to see it in action? You can:

  • Use the CLI flag --help-examples on any command
  • Or browse through real examples in the docs:
    :page_facing_up: stm messaging examples

Additional Resources:

Have you tried stm yet? What’s your experience been like? Any specific feature or use cases you’d like to see? Let’s discuss!