Documentation
¶
Overview ¶
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
This package contains the root command and all subcommands for the StackEye CLI tool. Commands are organized hierarchically using Cobra.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Package cmd implements the CLI commands for StackEye.
Index ¶
- func Execute() error
- func ExecuteWithExitCode() int
- func GetConfig() *config.Config
- func GetConfigOrFail() *config.Config
- func GetDryRun() bool
- func GetNoInput() bool
- func GetVerbosity() int
- func InitHelp(cmd *cobra.Command, cfg *HelpConfig)
- func NewAPIKeyCmd() *cobra.Command
- func NewAPIKeyCreateCmd() *cobra.Command
- func NewAPIKeyDeleteCmd() *cobra.Command
- func NewAPIKeyListCmd() *cobra.Command
- func NewAdminCmd() *cobra.Command
- func NewAdminM2MKeyCmd() *cobra.Command
- func NewAdminM2MKeyCreateCmd() *cobra.Command
- func NewAdminM2MKeyDeactivateCmd() *cobra.Command
- func NewAdminM2MKeyGetCmd() *cobra.Command
- func NewAdminM2MKeyListCmd() *cobra.Command
- func NewAdminM2MKeyRotateCmd() *cobra.Command
- func NewAdminWorkerKeyCmd() *cobra.Command
- func NewAdminWorkerKeyCreateCmd() *cobra.Command
- func NewAdminWorkerKeyDeleteCmd() *cobra.Command
- func NewAdminWorkerKeyHealthCmd() *cobra.Command
- func NewAlertAckCmd() *cobra.Command
- func NewAlertCmd() *cobra.Command
- func NewAlertGetCmd() *cobra.Command
- func NewAlertHistoryCmd() *cobra.Command
- func NewAlertListCmd() *cobra.Command
- func NewAlertResolveCmd() *cobra.Command
- func NewAlertStatsCmd() *cobra.Command
- func NewBillingCmd() *cobra.Command
- func NewBillingInfoCmd() *cobra.Command
- func NewBillingInvoicesCmd() *cobra.Command
- func NewBillingPortalCmd() *cobra.Command
- func NewBillingStatusCmd() *cobra.Command
- func NewBillingUsageCmd() *cobra.Command
- func NewChannelCmd() *cobra.Command
- func NewChannelCreateCmd() *cobra.Command
- func NewChannelDeleteCmd() *cobra.Command
- func NewChannelGetCmd() *cobra.Command
- func NewChannelListCmd() *cobra.Command
- func NewChannelTestCmd() *cobra.Command
- func NewChannelUpdateCmd() *cobra.Command
- func NewCompletionCmd() *cobra.Command
- func NewConfigCmd() *cobra.Command
- func NewContextCmd() *cobra.Command
- func NewDashboardCmd() *cobra.Command
- func NewIncidentCmd() *cobra.Command
- func NewIncidentCreateCmd() *cobra.Command
- func NewIncidentDeleteCmd() *cobra.Command
- func NewIncidentListCmd() *cobra.Command
- func NewIncidentResolveCmd() *cobra.Command
- func NewIncidentUpdateCmd() *cobra.Command
- func NewLoginCmd() *cobra.Command
- func NewLogoutCmd() *cobra.Command
- func NewMaintenanceCalendarCmd() *cobra.Command
- func NewMaintenanceCmd() *cobra.Command
- func NewMaintenanceCreateCmd() *cobra.Command
- func NewMaintenanceDeleteCmd() *cobra.Command
- func NewMaintenanceListCmd() *cobra.Command
- func NewMuteCmd() *cobra.Command
- func NewMuteCreateCmd() *cobra.Command
- func NewMuteDeleteCmd() *cobra.Command
- func NewMuteExpireCmd() *cobra.Command
- func NewMuteGetCmd() *cobra.Command
- func NewMuteListCmd() *cobra.Command
- func NewOrgCmd() *cobra.Command
- func NewOrgGetCmd() *cobra.Command
- func NewOrgListCmd() *cobra.Command
- func NewOrgSwitchCmd() *cobra.Command
- func NewProbeCmd() *cobra.Command
- func NewProbeCreateCmd() *cobra.Command
- func NewProbeDeleteCmd() *cobra.Command
- func NewProbeDepsAddCmd() *cobra.Command
- func NewProbeDepsCmd() *cobra.Command
- func NewProbeDepsListCmd() *cobra.Command
- func NewProbeGetCmd() *cobra.Command
- func NewProbeHistoryCmd() *cobra.Command
- func NewProbeLinkChannelCmd() *cobra.Command
- func NewProbeListCmd() *cobra.Command
- func NewProbePauseCmd() *cobra.Command
- func NewProbeResumeCmd() *cobra.Command
- func NewProbeStatsCmd() *cobra.Command
- func NewProbeTestCmd() *cobra.Command
- func NewProbeUpdateCmd() *cobra.Command
- func NewProbeWizardCmd() *cobra.Command
- func NewRegionCmd() *cobra.Command
- func NewRegionListCmd() *cobra.Command
- func NewRegionStatusCmd() *cobra.Command
- func NewSetupCmd() *cobra.Command
- func NewStatusPageAddProbeCmd() *cobra.Command
- func NewStatusPageCmd() *cobra.Command
- func NewStatusPageCreateCmd() *cobra.Command
- func NewStatusPageDeleteCmd() *cobra.Command
- func NewStatusPageDomainVerifyCmd() *cobra.Command
- func NewStatusPageGetCmd() *cobra.Command
- func NewStatusPageGetStatusCmd() *cobra.Command
- func NewStatusPageListCmd() *cobra.Command
- func NewStatusPageRemoveProbeCmd() *cobra.Command
- func NewStatusPageReorderProbesCmd() *cobra.Command
- func NewStatusPageUpdateCmd() *cobra.Command
- func NewTeamCmd() *cobra.Command
- func NewTeamInvitationsCmd() *cobra.Command
- func NewTeamInviteCmd() *cobra.Command
- func NewTeamListCmd() *cobra.Command
- func NewTeamRemoveCmd() *cobra.Command
- func NewTeamRevokeInvitationCmd() *cobra.Command
- func NewTeamUpdateRoleCmd() *cobra.Command
- func NewVersionCmd() *cobra.Command
- func NewWhoamiCmd() *cobra.Command
- func RenderHelp(cmd *cobra.Command) (string, error)
- func RootCmd() *cobra.Command
- func SetNoColor(disabled bool)
- type AlertAckBatchResponse
- type AlertAckError
- type AlertAckResponse
- type AlertGetResponse
- type AlertResolveBatchResponse
- type AlertResolveError
- type AlertResolveResponse
- type ChannelTestResult
- type CommandGroup
- type HelpConfig
- type OrgDetail
- type ProbeHistoryEntry
- type ProbeHistoryOutput
- type ProbeStatsOutput
- type ProbeTestResult
- type SwitchResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Execute ¶
func Execute() error
Execute runs the root command and returns any error. This is called by main.main() and handles command execution. Deprecated: Use ExecuteWithExitCode() for proper exit code handling.
func ExecuteWithExitCode ¶
func ExecuteWithExitCode() int
ExecuteWithExitCode runs the root command and returns an appropriate exit code. This maps errors to exit codes for proper CLI behavior:
- 0: Success
- 1: General error
- 2: Command misuse (invalid arguments)
- 3: Authentication required
- 4: Permission denied
- 5: Resource not found
- 6: Rate limited
- 7: Server error
- 8: Network error
- 9: Timeout
- 10: Plan limit exceeded
Example usage in main.go:
func main() {
os.Exit(cmd.ExecuteWithExitCode())
}
func GetConfig ¶
GetConfig returns the loaded configuration. Returns nil if called before Execute() or if config loading failed. Subcommands should call this in their Run/RunE functions.
func GetConfigOrFail ¶
GetConfigOrFail returns the loaded configuration or exits with an error. This is a convenience function for commands that require a valid config.
func GetDryRun ¶
func GetDryRun() bool
GetDryRun returns true if commands should show what would be done without executing. Commands that modify state should check this and print their intended actions instead.
func GetNoInput ¶
func GetNoInput() bool
GetNoInput returns true if interactive prompts should be disabled. Commands should check this before prompting for user input.
func GetVerbosity ¶
func GetVerbosity() int
GetVerbosity returns the kubectl-style verbosity level (0-10). Level meanings:
- 0: Errors only (default)
- 1: Warnings + errors
- 2: Info messages
- 3: Extended info (config/context details)
- 4: Debug messages (internal flow)
- 5: HTTP requests (method, URL, duration)
- 6: HTTP responses (+ status code, body size)
- 7: Request headers (redacted)
- 8: Response headers
- 9: Full bodies (truncated at 10KB)
- 10: Trace (curl equivalent, timing breakdown)
func InitHelp ¶
func InitHelp(cmd *cobra.Command, cfg *HelpConfig)
InitHelp initializes the custom help system for the CLI. This should be called after creating the root command.
Example:
rootCmd := NewRootCmd()
InitHelp(rootCmd, &HelpConfig{
ColorManager: output.NewColorManager(output.ColorAuto),
})
func NewAPIKeyCmd ¶
NewAPIKeyCmd creates and returns the api-key parent command. This command provides management of API keys for programmatic access.
func NewAPIKeyCreateCmd ¶
NewAPIKeyCreateCmd creates and returns the api-key create subcommand.
func NewAPIKeyDeleteCmd ¶
NewAPIKeyDeleteCmd creates and returns the api-key delete subcommand.
func NewAPIKeyListCmd ¶
NewAPIKeyListCmd creates and returns the api-key list subcommand.
func NewAdminCmd ¶
NewAdminCmd creates and returns the admin parent command. This command provides access to platform administration features. Admin commands require platform administrator privileges.
func NewAdminM2MKeyCmd ¶
NewAdminM2MKeyCmd creates and returns the admin m2m-key parent command. This command provides access to machine-to-machine key management features.
func NewAdminM2MKeyCreateCmd ¶
NewAdminM2MKeyCreateCmd creates and returns the m2m-key create command.
func NewAdminM2MKeyDeactivateCmd ¶
NewAdminM2MKeyDeactivateCmd creates and returns the m2m-key deactivate command.
func NewAdminM2MKeyGetCmd ¶
NewAdminM2MKeyGetCmd creates and returns the m2m-key get command.
func NewAdminM2MKeyListCmd ¶
NewAdminM2MKeyListCmd creates and returns the m2m-key list command.
func NewAdminM2MKeyRotateCmd ¶
NewAdminM2MKeyRotateCmd creates and returns the m2m-key rotate command.
func NewAdminWorkerKeyCmd ¶
NewAdminWorkerKeyCmd creates and returns the admin worker-key parent command. This command provides access to worker key management features.
func NewAdminWorkerKeyCreateCmd ¶
NewAdminWorkerKeyCreateCmd creates and returns the worker-key create command.
func NewAdminWorkerKeyDeleteCmd ¶
NewAdminWorkerKeyDeleteCmd creates and returns the worker-key delete command.
func NewAdminWorkerKeyHealthCmd ¶
NewAdminWorkerKeyHealthCmd creates and returns the worker-key health command.
func NewAlertAckCmd ¶
NewAlertAckCmd creates and returns the alert ack subcommand.
func NewAlertCmd ¶
NewAlertCmd creates and returns the alert parent command. This command provides management of monitoring alerts.
func NewAlertGetCmd ¶
NewAlertGetCmd creates and returns the alert get subcommand.
func NewAlertHistoryCmd ¶
NewAlertHistoryCmd creates and returns the alert history subcommand.
func NewAlertListCmd ¶
NewAlertListCmd creates and returns the alert list subcommand.
func NewAlertResolveCmd ¶
NewAlertResolveCmd creates and returns the alert resolve subcommand.
func NewAlertStatsCmd ¶
NewAlertStatsCmd creates and returns the alert stats subcommand.
func NewBillingCmd ¶
NewBillingCmd creates and returns the billing parent command. This command provides access to billing and subscription information.
func NewBillingInfoCmd ¶
NewBillingInfoCmd creates and returns the billing info command.
func NewBillingInvoicesCmd ¶
NewBillingInvoicesCmd creates and returns the billing invoices command.
func NewBillingPortalCmd ¶
NewBillingPortalCmd creates and returns the billing portal command.
func NewBillingStatusCmd ¶
NewBillingStatusCmd creates and returns the billing status command.
func NewBillingUsageCmd ¶
NewBillingUsageCmd creates and returns the billing usage command.
func NewChannelCmd ¶
NewChannelCmd creates and returns the channel parent command. This command provides management of notification channels.
func NewChannelCreateCmd ¶
NewChannelCreateCmd creates and returns the channel create subcommand.
func NewChannelDeleteCmd ¶
NewChannelDeleteCmd creates and returns the channel delete subcommand.
func NewChannelGetCmd ¶
NewChannelGetCmd creates and returns the channel get subcommand.
func NewChannelListCmd ¶
NewChannelListCmd creates and returns the channel list subcommand.
func NewChannelTestCmd ¶
NewChannelTestCmd creates and returns the channel test subcommand.
func NewChannelUpdateCmd ¶
NewChannelUpdateCmd creates and returns the channel update subcommand.
func NewCompletionCmd ¶
NewCompletionCmd creates and returns the completion parent command. This command provides shell completion script generation.
Usage:
stackeye completion bash > ~/.bash_completion.d/stackeye
func NewConfigCmd ¶
NewConfigCmd creates and returns the config parent command.
func NewContextCmd ¶
NewContextCmd creates and returns the context parent command.
func NewDashboardCmd ¶
NewDashboardCmd creates and returns the dashboard command.
func NewIncidentCmd ¶
NewIncidentCmd creates and returns the incident parent command. This command provides management of status page incidents.
func NewIncidentCreateCmd ¶
NewIncidentCreateCmd creates and returns the incident create subcommand.
func NewIncidentDeleteCmd ¶
NewIncidentDeleteCmd creates and returns the incident delete subcommand.
func NewIncidentListCmd ¶
NewIncidentListCmd creates and returns the incident list subcommand.
func NewIncidentResolveCmd ¶
NewIncidentResolveCmd creates and returns the incident resolve subcommand.
func NewIncidentUpdateCmd ¶
NewIncidentUpdateCmd creates and returns the incident update subcommand.
func NewLoginCmd ¶
NewLoginCmd creates and returns the login command.
func NewLogoutCmd ¶
NewLogoutCmd creates and returns the logout command.
func NewMaintenanceCalendarCmd ¶
NewMaintenanceCalendarCmd creates and returns the maintenance calendar subcommand.
func NewMaintenanceCmd ¶
NewMaintenanceCmd creates and returns the maintenance parent command. This command provides management of scheduled maintenance windows.
func NewMaintenanceCreateCmd ¶
NewMaintenanceCreateCmd creates and returns the maintenance create subcommand.
func NewMaintenanceDeleteCmd ¶
NewMaintenanceDeleteCmd creates and returns the maintenance delete subcommand.
func NewMaintenanceListCmd ¶
NewMaintenanceListCmd creates and returns the maintenance list subcommand.
func NewMuteCmd ¶
NewMuteCmd creates and returns the mute parent command. This command provides management of alert mute periods.
func NewMuteCreateCmd ¶
NewMuteCreateCmd creates and returns the mute create subcommand.
func NewMuteDeleteCmd ¶
NewMuteDeleteCmd creates and returns the mute delete subcommand.
func NewMuteExpireCmd ¶
NewMuteExpireCmd creates and returns the mute expire subcommand.
func NewMuteGetCmd ¶
NewMuteGetCmd creates and returns the mute get subcommand.
func NewMuteListCmd ¶
NewMuteListCmd creates and returns the mute list subcommand.
func NewOrgCmd ¶
NewOrgCmd creates and returns the org parent command. This command provides management of organizations.
func NewOrgGetCmd ¶
NewOrgGetCmd creates and returns the org get subcommand.
func NewOrgListCmd ¶
NewOrgListCmd creates and returns the org list subcommand.
func NewOrgSwitchCmd ¶
NewOrgSwitchCmd creates and returns the org switch subcommand.
func NewProbeCmd ¶
NewProbeCmd creates and returns the probe parent command. This command provides management of monitoring probes.
func NewProbeCreateCmd ¶
NewProbeCreateCmd creates and returns the probe create subcommand.
func NewProbeDeleteCmd ¶
NewProbeDeleteCmd creates and returns the probe delete subcommand.
func NewProbeDepsAddCmd ¶
NewProbeDepsAddCmd creates and returns the probe deps add subcommand.
func NewProbeDepsCmd ¶
NewProbeDepsCmd creates and returns the probe deps parent command. This command provides management of probe dependencies for hierarchical alerting.
func NewProbeDepsListCmd ¶
NewProbeDepsListCmd creates and returns the probe deps list subcommand.
func NewProbeGetCmd ¶
NewProbeGetCmd creates and returns the probe get subcommand.
func NewProbeHistoryCmd ¶
NewProbeHistoryCmd creates and returns the probe history subcommand.
func NewProbeLinkChannelCmd ¶
NewProbeLinkChannelCmd creates and returns the probe link-channel subcommand.
func NewProbeListCmd ¶
NewProbeListCmd creates and returns the probe list subcommand.
func NewProbePauseCmd ¶
NewProbePauseCmd creates and returns the probe pause subcommand.
func NewProbeResumeCmd ¶
NewProbeResumeCmd creates and returns the probe resume subcommand.
func NewProbeStatsCmd ¶
NewProbeStatsCmd creates and returns the probe stats subcommand.
func NewProbeTestCmd ¶
NewProbeTestCmd creates and returns the probe test subcommand.
func NewProbeUpdateCmd ¶
NewProbeUpdateCmd creates and returns the probe update subcommand.
func NewProbeWizardCmd ¶
NewProbeWizardCmd creates and returns the probe wizard command.
func NewRegionCmd ¶
NewRegionCmd creates and returns the region parent command. This command provides information about monitoring regions.
func NewRegionListCmd ¶
NewRegionListCmd creates and returns the region list subcommand.
func NewRegionStatusCmd ¶
NewRegionStatusCmd creates and returns the region status subcommand.
func NewSetupCmd ¶
NewSetupCmd creates and returns the setup command.
func NewStatusPageAddProbeCmd ¶
NewStatusPageAddProbeCmd creates and returns the status-page add-probe subcommand.
func NewStatusPageCmd ¶
NewStatusPageCmd creates and returns the status-page parent command. This command provides management of public status pages.
func NewStatusPageCreateCmd ¶
NewStatusPageCreateCmd creates and returns the status-page create subcommand.
func NewStatusPageDeleteCmd ¶
NewStatusPageDeleteCmd creates and returns the status-page delete subcommand.
func NewStatusPageDomainVerifyCmd ¶
NewStatusPageDomainVerifyCmd creates and returns the status-page domain-verify subcommand.
func NewStatusPageGetCmd ¶
NewStatusPageGetCmd creates and returns the status-page get subcommand.
func NewStatusPageGetStatusCmd ¶
NewStatusPageGetStatusCmd creates and returns the status-page get-status subcommand.
func NewStatusPageListCmd ¶
NewStatusPageListCmd creates and returns the status-page list subcommand.
func NewStatusPageRemoveProbeCmd ¶
NewStatusPageRemoveProbeCmd creates and returns the status-page remove-probe subcommand.
func NewStatusPageReorderProbesCmd ¶
NewStatusPageReorderProbesCmd creates and returns the status-page reorder-probes subcommand.
func NewStatusPageUpdateCmd ¶
NewStatusPageUpdateCmd creates and returns the status-page update subcommand.
func NewTeamCmd ¶
NewTeamCmd creates and returns the team parent command. This command provides management of team members and invitations.
func NewTeamInvitationsCmd ¶
NewTeamInvitationsCmd creates and returns the team invitations subcommand.
func NewTeamInviteCmd ¶
NewTeamInviteCmd creates and returns the team invite subcommand.
func NewTeamListCmd ¶
NewTeamListCmd creates and returns the team list subcommand.
func NewTeamRemoveCmd ¶
NewTeamRemoveCmd creates and returns the team remove subcommand.
func NewTeamRevokeInvitationCmd ¶
NewTeamRevokeInvitationCmd creates and returns the team revoke-invitation subcommand.
func NewTeamUpdateRoleCmd ¶
NewTeamUpdateRoleCmd creates and returns the team update-role subcommand.
func NewVersionCmd ¶
NewVersionCmd creates and returns the version command.
func NewWhoamiCmd ¶
NewWhoamiCmd creates and returns the whoami command.
func RenderHelp ¶
RenderHelp renders the help output for a command. This can be used to test help rendering.
func RootCmd ¶
RootCmd returns the root command for adding subcommands. This is used by subcommand packages to register themselves.
func SetNoColor ¶
func SetNoColor(disabled bool)
SetNoColor updates the help system to disable colors. This is called when --no-color flag is set.
Types ¶
type AlertAckBatchResponse ¶
type AlertAckBatchResponse struct {
Acknowledged []*client.Alert `json:"acknowledged"`
Failed []AlertAckError `json:"failed,omitempty"`
Total int `json:"total"`
SuccessCount int `json:"success_count"`
FailedCount int `json:"failed_count"`
}
AlertAckBatchResponse wraps multiple acknowledged alerts for batch output.
type AlertAckError ¶
AlertAckError represents a failed acknowledgment attempt.
type AlertAckResponse ¶
type AlertAckResponse struct {
Alert *client.Alert `json:"alert"`
Message string `json:"message,omitempty"`
}
AlertAckResponse wraps the acknowledged alert data for output.
type AlertGetResponse ¶
type AlertGetResponse struct {
Alert *client.Alert `json:"alert"`
Timeline []client.AlertTimelineEvent `json:"timeline,omitempty"`
}
AlertGetResponse wraps the alert data with optional timeline for output.
type AlertResolveBatchResponse ¶
type AlertResolveBatchResponse struct {
Resolved []*client.Alert `json:"resolved"`
Failed []AlertResolveError `json:"failed,omitempty"`
Total int `json:"total"`
SuccessCount int `json:"success_count"`
FailedCount int `json:"failed_count"`
}
AlertResolveBatchResponse wraps multiple resolved alerts for batch output.
type AlertResolveError ¶
AlertResolveError represents a failed resolution attempt.
type AlertResolveResponse ¶
type AlertResolveResponse struct {
Alert *client.Alert `json:"alert"`
Message string `json:"message,omitempty"`
}
AlertResolveResponse wraps the resolved alert data for output.
type ChannelTestResult ¶
type ChannelTestResult struct {
ChannelID uuid.UUID `json:"channel_id" yaml:"channel_id"`
ChannelName string `json:"channel_name" yaml:"channel_name"`
ChannelType string `json:"channel_type" yaml:"channel_type"`
Success bool `json:"success" yaml:"success"`
Message string `json:"message" yaml:"message"`
Error *string `json:"error,omitempty" yaml:"error,omitempty"`
ResponseTimeMs int `json:"response_time_ms" yaml:"response_time_ms"`
}
ChannelTestResult wraps the test response with channel metadata for output formatting. This struct is exported to allow JSON/YAML serialization with proper field tags.
type CommandGroup ¶
CommandGroup represents a logical grouping of commands for help output.
func GroupCommands ¶
func GroupCommands(commands []*cobra.Command) []CommandGroup
GroupCommands organizes commands into logical groups for display.
type HelpConfig ¶
type HelpConfig struct {
// ColorManager provides colored output formatting.
ColorManager *output.ColorManager
// Writer is the output destination (defaults to os.Stdout).
Writer io.Writer
}
HelpConfig holds configuration for the custom help system.
func GetHelpConfig ¶
func GetHelpConfig() *HelpConfig
GetHelpConfig returns the current help configuration. Returns a default config if InitHelp hasn't been called.
type OrgDetail ¶
type OrgDetail struct {
// Basic organization info
ID string `json:"id"`
Name string `json:"name"`
Slug string `json:"slug"`
Role string `json:"role"`
IsCurrent bool `json:"is_current"`
// Plan and billing info
Plan string `json:"plan"`
PlanStatus string `json:"plan_status"`
TrialEndsAt *string `json:"trial_ends_at,omitempty"`
NextBillingAt *string `json:"next_billing_at,omitempty"`
// Usage and limits
MonitorCount int `json:"monitor_count"`
MonitorLimit int `json:"monitor_limit"`
TeamMemberCount int `json:"team_member_count"`
TeamMemberLimit int `json:"team_member_limit"`
}
OrgDetail combines organization info with billing and usage details.
type ProbeHistoryEntry ¶
type ProbeHistoryEntry struct {
ID uuid.UUID `json:"id" yaml:"id"`
CheckedAt time.Time `json:"checked_at" yaml:"checked_at"`
Region string `json:"region" yaml:"region"`
Status string `json:"status" yaml:"status"`
ResponseTimeMs int `json:"response_time_ms" yaml:"response_time_ms"`
StatusCode *int `json:"status_code,omitempty" yaml:"status_code,omitempty"`
ErrorMessage *string `json:"error_message,omitempty" yaml:"error_message,omitempty"`
SSLExpiryDays *int `json:"ssl_expiry_days,omitempty" yaml:"ssl_expiry_days,omitempty"`
}
ProbeHistoryEntry represents a single check result in the history output.
type ProbeHistoryOutput ¶
type ProbeHistoryOutput struct {
ProbeID uuid.UUID `json:"probe_id" yaml:"probe_id"`
Results []ProbeHistoryEntry `json:"results" yaml:"results"`
Total int64 `json:"total" yaml:"total"`
Page int `json:"page" yaml:"page"`
Limit int `json:"limit" yaml:"limit"`
}
ProbeHistoryOutput wraps probe results for output formatting. This struct is exported to allow JSON/YAML serialization with proper field tags.
type ProbeStatsOutput ¶
type ProbeStatsOutput struct {
ProbeID uuid.UUID `json:"probe_id" yaml:"probe_id"`
Period string `json:"period" yaml:"period"`
UptimePercent float64 `json:"uptime_percent" yaml:"uptime_percent"`
TotalChecks int64 `json:"total_checks" yaml:"total_checks"`
SuccessChecks int64 `json:"success_checks" yaml:"success_checks"`
FailureChecks int64 `json:"failure_checks" yaml:"failure_checks"`
AvgResponseMs float64 `json:"avg_response_time_ms" yaml:"avg_response_time_ms"`
P95ResponseMs float64 `json:"p95_response_time_ms" yaml:"p95_response_time_ms"`
P99ResponseMs float64 `json:"p99_response_time_ms" yaml:"p99_response_time_ms"`
MinResponseMs int `json:"min_response_time_ms" yaml:"min_response_time_ms"`
MaxResponseMs int `json:"max_response_time_ms" yaml:"max_response_time_ms"`
From time.Time `json:"from" yaml:"from"`
To time.Time `json:"to" yaml:"to"`
TimeBuckets int `json:"time_buckets" yaml:"time_buckets"`
}
ProbeStatsOutput wraps probe statistics for output formatting. This struct is exported to allow JSON/YAML serialization with proper field tags.
type ProbeTestResult ¶
type ProbeTestResult struct {
ProbeID uuid.UUID `json:"probe_id" yaml:"probe_id"`
ProbeName string `json:"probe_name" yaml:"probe_name"`
ProbeURL string `json:"probe_url" yaml:"probe_url"`
Status string `json:"status" yaml:"status"`
ResponseTimeMs int `json:"response_time_ms" yaml:"response_time_ms"`
StatusCode *int `json:"status_code,omitempty" yaml:"status_code,omitempty"`
ErrorMessage *string `json:"error_message,omitempty" yaml:"error_message,omitempty"`
SSLExpiryDays *int `json:"ssl_expiry_days,omitempty" yaml:"ssl_expiry_days,omitempty"`
CheckedAt time.Time `json:"checked_at" yaml:"checked_at"`
}
ProbeTestResult wraps the test response with probe metadata for output formatting. This struct is exported to allow JSON/YAML serialization with proper field tags.
type SwitchResult ¶
type SwitchResult struct {
OrganizationID string `json:"organization_id"`
OrganizationName string `json:"organization_name"`
OrganizationSlug string `json:"organization_slug"`
Role string `json:"role"`
Message string `json:"message"`
}
SwitchResult represents the result of an organization switch.
Source Files
¶
- admin.go
- admin_m2m_key.go
- admin_m2m_key_create.go
- admin_m2m_key_deactivate.go
- admin_m2m_key_get.go
- admin_m2m_key_list.go
- admin_m2m_key_rotate.go
- admin_worker_key.go
- admin_worker_key_create.go
- admin_worker_key_delete.go
- admin_worker_key_health.go
- alert.go
- alert_ack.go
- alert_get.go
- alert_history.go
- alert_list.go
- alert_resolve.go
- alert_stats.go
- apikey.go
- apikey_create.go
- apikey_delete.go
- apikey_list.go
- billing.go
- billing_info.go
- billing_invoices.go
- billing_portal.go
- billing_status.go
- billing_usage.go
- channel.go
- channel_create.go
- channel_delete.go
- channel_get.go
- channel_list.go
- channel_runtest.go
- channel_update.go
- completion.go
- completion_bash.go
- completion_fish.go
- completion_powershell.go
- completion_zsh.go
- config.go
- context.go
- dashboard.go
- help.go
- incident.go
- incident_create.go
- incident_delete.go
- incident_list.go
- incident_resolve.go
- incident_update.go
- login.go
- logout.go
- maintenance.go
- maintenance_calendar.go
- maintenance_create.go
- maintenance_delete.go
- maintenance_list.go
- mute.go
- mute_create.go
- mute_delete.go
- mute_expire.go
- mute_get.go
- mute_list.go
- org.go
- org_get.go
- org_list.go
- org_switch.go
- probe.go
- probe_create.go
- probe_delete.go
- probe_deps.go
- probe_deps_add.go
- probe_deps_list.go
- probe_get.go
- probe_history.go
- probe_link_channel.go
- probe_list.go
- probe_pause.go
- probe_resume.go
- probe_runtest.go
- probe_stats.go
- probe_update.go
- probe_wizard.go
- region.go
- region_list.go
- region_status.go
- root.go
- setup.go
- status_page.go
- status_page_add_probe.go
- status_page_create.go
- status_page_delete.go
- status_page_domain_verify.go
- status_page_get.go
- status_page_get_status.go
- status_page_list.go
- status_page_remove_probe.go
- status_page_reorder_probes.go
- status_page_update.go
- team.go
- team_invitations.go
- team_invite.go
- team_list.go
- team_remove.go
- team_revoke_invitation.go
- team_update_role.go
- version.go
- whoami.go