Skip to content

Improve some command wording #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KodrAus merged 1 commit into from
Feb 29, 2024
Merged

Improve some command wording #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Forwarder/InstallCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

namespace Seq.Forwarder.Cli.Commands
{
[Command("forwarder", "install", "Install the Seq Forwarder as a Windows service")]
[Command("forwarder", "install", "Install the forwarder as a Windows service")]
[SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]
class InstallCommand : Command
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Forwarder/RestartCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

namespace Seq.Forwarder.Cli.Commands
{
[Command("forwarder", "restart", "Restart the Windows service")]
[Command("forwarder", "restart", "Restart the forwarder Windows service")]
[SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]
class RestartCommand : Command
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Forwarder/RunCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

namespace SeqCli.Cli.Commands.Forwarder;

[Command("forwarder", "run", "Run the server interactively")]
[Command("forwarder", "run", "Listen on an HTTP endpoint and forward ingested logs to Seq")]
class RunCommand : Command
{
readonly StoragePathFeature _storagePath;
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Forwarder/StartCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

namespace Seq.Forwarder.Cli.Commands
{
[Command("forwarder", "start", "Start the Windows service")]
[Command("forwarder", "start", "Start the forwarder Windows service")]
[SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]
class StartCommand : Command
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Forwarder/StatusCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

namespace Seq.Forwarder.Cli.Commands
{
[Command("forwarder", "status", "Show the status of the Seq Forwarder service")]
[Command("forwarder", "status", "Show the status of the forwarder Windows service")]
[SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]
class StatusCommand : Command
{
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Forwarder/StopCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

namespace Seq.Forwarder.Cli.Commands
{
[Command("forwarder", "stop", "Stop the Windows service")]
[Command("forwarder", "stop", "Stop the forwarder Windows service")]
[SuppressMessage("Interoperability", "CA1416:Validate platform compatibility")]
class StopCommand : Command
{
Expand Down
7 changes: 6 additions & 1 deletion src/SeqCli/Cli/Commands/Forwarder/TruncateCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,25 @@

namespace SeqCli.Cli.Commands.Forwarder;

[Command("forwarder", "truncate", "Clear the log buffer contents")]
[Command("forwarder", "truncate", "Empty the forwarder's persistent log buffer")]
class TruncateCommand : Command
{
readonly StoragePathFeature _storagePath;
readonly ConfirmFeature _confirm;

public TruncateCommand()
{
_storagePath = Enable<StoragePathFeature>();
_confirm = Enable<ConfirmFeature>();
}

protected override async Task<int> Run(string[] args)
{
try
{
if (!_confirm.TryConfirm("All data in the forwarder's log buffer will be deleted. This cannot be undone."))
return 1;

ActiveLogBufferMap.Truncate(_storagePath.BufferPath);
return 0;
}
Expand Down
2 changes: 1 addition & 1 deletion src/SeqCli/Cli/Commands/Forwarder/UninstallCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

namespace Seq.Forwarder.Cli.Commands
{
[Command("forwarder", "uninstall", "Uninstall the Windows service")]
[Command("forwarder", "uninstall", "Uninstall the forwarder Windows service")]
class UninstallCommand : Command
{
protected override Task<int> Run()
Expand Down