Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@

# Overview

**Busly CLI** is a lightweight, open source command-line tool that **allows developers to send messages to an NServiceBus endpoint at the power of their fingertips** — no boilerplate code, no host applications, just quick and reliable messaging from your terminal.
**Busly CLI** is a lightweight, open source command-line tool that **allows developers to send messages to an NServiceBus endpoint at the power of their fingertips** — No boilerplate, no fuss, just messaging at your fingertips.

Built for speed and simplicity, this tool streamlines common **messaging**, **testing**, and **debugging** scenarios when working with **NServiceBus** and **message-driven architectures**. **Busly CLI** is fully **cross-platform**, running on Windows, macOS, and Linux, and offers **multiple installation options** to suit your workflow. Whether you’re validating endpoints, simulating events, or quickly **implementing a proof of concept (POC)** for a new messaging solution, this CLI lets you publish or send messages instantly, giving you full control of your distributed system from the command line.

## Key Features

- 🚀 **Send messages via CLI** – Quickly send commands or publish events to NServiceBus endpoints.
- 🧩 **Supports custom message types** – Define and send serialized payloads that match your message contracts.
- 🌐 **Supported transports** – Works with **Azure Service Bus**, **RabbitMQ**, and **AWS SQS**.
- ⚙️ **Transport configuration file** – Configure and easily switch between multiple transports. Transports can run on your **local machine** or be pointed to **development**, **staging**, or **production** environments.
- 💻 **Cross-platform support** – Works seamlessly on Windows, macOS, and Linux.
- 📦 **Multiple installation options** – Install via **Chocolatey**, **Docker**, **.NET tool (via NuGet)**, or by **downloading the binary directly from GitHub Releases**.
- 🚀 **Send messages via CLI** – Quickly send commands or publish events to NServiceBus endpoints.
- 🧩 **Supports custom message types** – Define and send serialized payloads that match your message contracts.
- 🌐 **Supported transports** – Works with **Azure Service Bus**, **RabbitMQ**, and **AWS SQS**.
- ⚙️ **Transport configuration file** – Configure and easily switch between multiple transports. Transports can run on your **local machine** or be pointed to **development**, **staging**, or **production** environments.
- 💻 **Cross-platform support** – Works seamlessly on Windows, macOS, and Linux.
- 📦 **Multiple installation options** – Install via **Chocolatey**, **Docker**, **.NET tool (via NuGet)**, or by **downloading the binary directly from GitHub Releases**.

## Docs

Expand Down
22 changes: 11 additions & 11 deletions website/blog/2025-12-04-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,26 @@ authors: tragiccode
tags: []
---

Working with **NServiceBus** shouldn’t require spinning up a whole host application just to send a message. That’s why we built **Busly CLI** — a lightweight, cross-platform command-line tool that lets you **send commands and events instantly**. No boilerplate, no fuss, just messaging at your fingertips.
Working with **NServiceBus** shouldn’t require spinning up a whole host application just to send a message. That’s why I built **Busly CLI** — a lightweight, cross-platform command-line tool that lets you **send commands and events instantly**. No boilerplate, no fuss, just messaging at your fingertips.

<!-- truncate -->

## Why You’ll Love Busly CLI

- 🚀 **Send messages straight from your terminal**
- 🧩 **Use custom message types** that match your contracts
- 🌐 **Works with Azure Service Bus, RabbitMQ, and AWS SQS**
- ⚙️ **Easily switch transports** between local, dev, staging, or production
- 💻 **Runs on Windows, macOS, and Linux**
- 📦 **Install your way**: Chocolatey, Docker, .NET tool, or GitHub binary
- 🚀 **Send messages straight from your terminal**
- 🧩 **Use custom message types** that match your contracts
- 🌐 **Works with Azure Service Bus, RabbitMQ, and AWS SQS**
- ⚙️ **Easily switch transports** between local, dev, staging, or production
- 💻 **Runs on Windows, macOS, and Linux**
- 📦 **Install your way**: Chocolatey, Docker, .NET tool, or GitHub binary

## Help Us Reach 1.0.0

Busly CLI is shaping up fast, but we need your help to make **version 1.0.0 rock-solid**:
Busly CLI is shaping up fast, but I need your help to make **version 1.0.0 rock-solid**:

- **Try it out** and let us know what works (or doesn’t).
- **Report bugs** on GitHub — every issue helps!
- **Contribute** code, docs, or ideas — every contribution counts.
- **Try it out** and let us know what works (or doesn’t).
- **Report bugs** on GitHub — every issue helps!
- **Contribute** code, docs, or ideas — every contribution counts.

Together, we can make **Busly CLI** the go-to tool for messaging in NServiceBus. Jump in, experiment, and help us get to that **stable 1.0.0 release**!

Expand Down
2 changes: 1 addition & 1 deletion website/docs/configuration/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Configuration",
"position": 3
"position": 2
}
3 changes: 0 additions & 3 deletions website/docs/getting-started/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions website/docs/getting-started/getting-started.mdx

This file was deleted.

4 changes: 4 additions & 0 deletions website/docs/introduction/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 1,
"collapsed": false
}
28 changes: 28 additions & 0 deletions website/docs/introduction/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
sidebar_position: 1
title: Introduction
---

import DocCardList from "@theme/DocCardList";
import BuslyLogoImageUrl from '@site/static/img/busly-logo.png';

<div align="center">
<img src={BuslyLogoImageUrl} width="40%" />
</div>

# What is Busly CLI?

**Busly CLI** is a lightweight, open source command-line tool that **allows developers to send messages to an NServiceBus endpoint at the power of their fingertips** — No boilerplate, no fuss, just messaging at your fingertips.

Built for speed and simplicity, this tool streamlines common **messaging**, **testing**, and **debugging** scenarios when working with **NServiceBus** and **message-driven architectures**. **Busly CLI** is fully **cross-platform**, running on Windows, macOS, and Linux, and offers **multiple installation options** to suit your workflow. Whether you’re validating endpoints, simulating events, or quickly **implementing a proof of concept (POC)** for a new messaging solution, this CLI lets you publish or send messages instantly, giving you full control of your distributed system from the command line.

## Key Features

- 🚀 **Send messages via CLI** – Quickly send commands or publish events to NServiceBus endpoints.
- 🧩 **Supports custom message types** – Define and send serialized payloads that match your message contracts.
- 🌐 **Supported transports** – Works with **Azure Service Bus**, **RabbitMQ**, and **AWS SQS**.
- ⚙️ **Transport configuration file** – Configure and easily switch between multiple transports. Transports can run on your **local machine** or be pointed to **development**, **staging**, or **production** environments.
- 💻 **Cross-platform support** – Works seamlessly on Windows, macOS, and Linux.
- 📦 **Multiple installation options** – Install via **Chocolatey**, **Docker**, **.NET tool (via NuGet)**, or by **downloading the binary directly from GitHub Releases**.

<DocCardList />
3 changes: 3 additions & 0 deletions website/docs/terminal/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"position": 4
}
41 changes: 41 additions & 0 deletions website/docs/terminal/terminal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Terminal Customizations

If you use **Busly CLI** often, you may want to customize your terminal to always display the currently configured transport. This is especially helpful to quickly know whether you’re pointing to your local or a non-production environment.

Below is an example configuration using **Oh My Posh** to display the current transport in your prompt:

![Busly Oh My Posh Custom Segment](../../static/gifs/terminal-customization-oh-my-posh.gif)

---

## Oh My Posh Custom Segment

Assuming **Oh My Posh** is installed and configured for your shell, you can extend your theme by adding a **command segment** that invokes `busly transport current`:

```json
{
"$schema": "https://raw.githubusercontent.com/JanDeDobbeleer/oh-my-posh/main/themes/schema.json",
"blocks": [
{
"type": "prompt",
"alignment": "left",
"segments": [
// ... your existing segments ...
{
"type": "command",
"style": "powerline",
"powerline_symbol": "\ue0b0",
"background": "#4e9a06",
"foreground": "#000000",
"properties": {
"shell": "cmd",
"command": "/c busly transport current"
},
"template": "🚌 {{ .Output }}"
}
]
}
],
"final_space": true
}
```
1 change: 0 additions & 1 deletion website/docs/transports/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
{

"position": 3
}
4 changes: 2 additions & 2 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ const config = {
title: "Docs",
items: [
{
label: "Tutorial",
to: "/docs/getting-started",
label: "Introduction",
to: "/docs/introduction",
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion website/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function HomepageHeader() {
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/getting-started"
to="/docs/introduction"
>
Get Started
</Link>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.