diff --git a/README.md b/README.md index 4916362..a76f37f 100644 --- 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 index fa30c78..f30fa83 100644 --- 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. ## 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 index 8ab522c..2cc94c5 100644 --- 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 deleted file mode 100644 index 818afe3..0000000 --- a/website/docs/getting-started/_category_.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "position": 1 -} diff --git a/website/docs/getting-started/getting-started.mdx b/website/docs/getting-started/getting-started.mdx deleted file mode 100644 index 5b6642a..0000000 --- a/website/docs/getting-started/getting-started.mdx +++ /dev/null @@ -1,7 +0,0 @@ -import DocCardList from "@theme/DocCardList"; - -# Getting Started - -Everything you need for getting started with this tool. - - diff --git a/website/docs/introduction/_category_.json b/website/docs/introduction/_category_.json new file mode 100644 index 0000000..32853ee --- /dev/null +++ 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 new file mode 100644 index 0000000..fa6bc03 --- /dev/null +++ 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'; + +
+ +
+ +# 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**. + + diff --git a/website/docs/getting-started/quick-start.mdx b/website/docs/introduction/quick-start.mdx similarity index 100% rename from website/docs/getting-started/quick-start.mdx rename to website/docs/introduction/quick-start.mdx diff --git a/website/docs/terminal/_category_.json b/website/docs/terminal/_category_.json new file mode 100644 index 0000000..227b511 --- /dev/null +++ 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 new file mode 100644 index 0000000..d32cd7e --- /dev/null +++ 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 index 948bfea..e52c8d2 100644 --- 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 index a167a6a..c6c952f 100644 --- 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 index 71328c9..29f4ed4 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -19,7 +19,7 @@ function HomepageHeader() {
Get Started diff --git a/website/static/gifs/terminal-customization-oh-my-posh.gif b/website/static/gifs/terminal-customization-oh-my-posh.gif new file mode 100644 index 0000000..7c4c122 Binary files /dev/null and b/website/static/gifs/terminal-customization-oh-my-posh.gif differ