Cast.Cli
1.0.8
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet tool install --global Cast.Cli --version 1.0.8
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
dotnet tool install --local Cast.Cli --version 1.0.8
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Cast.Cli&version=1.0.8
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package Cast.Cli --version 1.0.8
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Cast
A command-line tool for scaffolding PlantUML sequence diagrams.
Cast turns command-line participants and messages into a PlantUML sequence diagram starter.
Requirements
- .NET SDK 8.0 or later (the tool targets
net8.0and runs on the .NET 8 runtime and later)
Build And Test
git clone https://github.com/QuinntyneBrown/Cast.git
cd Cast
dotnet build Cast.sln
dotnet test Cast.sln
Run From Source
Use dotnet run --project src/Cast.Cli -- followed by a Cast command:
dotnet run --project src/Cast.Cli -- generate `
-p actor:User `
-p "OS:Order Service" `
-p database:DB `
-m "User -> OS : place order" `
-m "OS -> DB : persist" `
--title "Checkout" `
--autonumber
Output:
@startuml
' Scaffolded by cast
title Checkout
autonumber
actor User
participant "Order Service" as OS
database DB
User -> OS : place order
OS -> DB : persist
@enduml
Commands
generate
Scaffolds a PlantUML sequence diagram from participants and optional messages.
| Option | Description |
|---|---|
-p, --participant <spec> |
Required, repeatable. Participant spec: [kind:]alias[:Display Name]. |
-m, --message <spec> |
Repeatable. Message spec: Source -> Target : label. |
-t, --title <text> |
Adds a PlantUML title. |
--autonumber |
Adds PlantUML autonumber. |
--theme <name> |
Adds PlantUML !theme <name>. |
-o, --output <file> |
Writes to a file instead of standard output. |
--force |
Overwrites an existing output file. |
--no-sample |
Disables placeholder messages when no --message values are supplied. |
Participant examples:
User
actor:Customer
database:DB:Main Database
Message examples:
User -> OS : place order
OS --> User : confirmation
When participants are supplied without messages, Cast generates a placeholder request/response flow
unless --no-sample is used.
kinds
Lists supported participant kind prefixes:
dotnet run --project src/Cast.Cli -- kinds
Supported kinds are participant, actor, boundary, control, entity, database,
collections, and queue.
Exit Codes
| Code | Meaning |
|---|---|
0 |
Success |
1 |
Usage error, such as malformed input or an unknown message endpoint |
2 |
I/O error, such as an existing output file without --force |
Project Layout
| Path | Description |
|---|---|
src/Cast.Cli/ |
CLI commands, hosting, models, diagnostics, and services |
tests/Cast.Cli.Tests/ |
xUnit tests |
License
Distributed under the MIT License. See LICENSE for details.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.