Merge pull request #146 from TraGicCode/chore/document-oh-my-posh-terminal-segment

TraGicCode · web-flow · commit d92f103c9418 · 2025-12-07T22:39:17.000-06:00
Add section for terminal customizations with oh-my-posh.  Also fix up introduction section
diff --git a/README.md b/README.md
@@ -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
 
diff --git a/website/blog/2025-12-04-introduction.md b/website/blog/2025-12-04-introduction.md
@@ -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**!
 
diff --git a/website/docs/configuration/_category_.json b/website/docs/configuration/_category_.json
@@ -1,4 +1,4 @@
 ﻿{
   "label": "Configuration",
-  "position": 3
+  "position": 2
 }
diff --git a/website/docs/getting-started/_category_.json b/website/docs/getting-started/_category_.json
diff --git a/website/docs/getting-started/getting-started.mdx b/website/docs/getting-started/getting-started.mdx
diff --git a/website/docs/introduction/_category_.json b/website/docs/introduction/_category_.json
@@ -0,0 +1,4 @@
+{
+  "position": 1,
+  "collapsed": false
+}
diff --git a/website/docs/introduction/introduction.mdx b/website/docs/introduction/introduction.mdx
@@ -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 />
diff --git a/website/docs/introduction/quick-start.mdx b/website/docs/introduction/quick-start.mdx
diff --git a/website/docs/terminal/_category_.json b/website/docs/terminal/_category_.json
@@ -0,0 +1,3 @@
+{
+  "position": 4
+}
diff --git a/website/docs/terminal/terminal.md b/website/docs/terminal/terminal.md
@@ -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
+}
+```
diff --git a/website/docs/transports/_category_.json b/website/docs/transports/_category_.json
@@ -1,4 +1,3 @@
 ﻿{
-
   "position": 3
 }
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -114,8 +114,8 @@ const config = {
                         title: "Docs",
                         items: [
                             {
-                                label: "Tutorial",
-                                to: "/docs/getting-started",
+                                label: "Introduction",
+                                to: "/docs/introduction",
                             },
                         ],
                     },
diff --git a/website/src/pages/index.js b/website/src/pages/index.js
@@ -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>
diff --git a/website/static/gifs/terminal-customization-oh-my-posh.gif b/website/static/gifs/terminal-customization-oh-my-posh.gif

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"label": "Configuration",`
`3`		`- "position": 3`
	`3`	`+ "position": 2`
`4`	`4`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "position": 1,
 +  "collapsed": false
 +}