Documentation
¶
Index ¶
- func Execute(name string) error
- func RootForDump() *cobra.Command
- func SetVersionInfo(version, commit, date string)
- type RunContext
- func (ctx *RunContext) PrintCappedList(items any, cols []output.Column, count, page, limit, total int, hasNext bool) error
- func (ctx *RunContext) PrintList(items any, cols []output.Column, count, page, limit, total int) error
- func (ctx *RunContext) PrintPage(items any, cols []output.Column, pg listPage) error
- func (ctx *RunContext) Structured() bool
- func (ctx *RunContext) WriteRaw(body []byte) error
- func (ctx *RunContext) WriteResult(message string)
- func (ctx *RunContext) WriteResultJSON(data any, humanMessage string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Execute ¶
Execute runs the root command as name, the command word the binary was invoked as. Help and error text is authored with the canonical "flashduty"; under any other name the tree's text and the returned error are rewritten to it, and cobra derives completion scripts from the root's name.
func RootForDump ¶ added in v1.3.15
RootForDump returns the fully-populated root command so dev tooling (the internal/cmd/skilldoc generator/validator) can build the command dump in-process, without shelling out to `flashduty __dump-commands`.
func SetVersionInfo ¶
func SetVersionInfo(version, commit, date string)
SetVersionInfo sets build-time version info from ldflags.
Types ¶
type RunContext ¶
type RunContext struct {
Client *flashduty.Client
Cmd *cobra.Command
Args []string
Writer io.Writer
Printer output.Printer
Format output.Format
}
RunContext provides helpers for command execution. It is created by runCommand and passed to the command's handler function. Client is the typed go-flashduty SDK every command calls through.
func (*RunContext) PrintCappedList ¶ added in v1.5.18
func (ctx *RunContext) PrintCappedList(items any, cols []output.Column, count, page, limit, total int, hasNext bool) error
PrintCappedList is PrintList for an endpoint whose total stops at serverCountCap; hasNext is the response's has_next_page.
func (*RunContext) PrintList ¶
func (ctx *RunContext) PrintList(items any, cols []output.Column, count, page, limit, total int) error
PrintList is PrintPage for a response that carried a total.
func (*RunContext) PrintPage ¶ added in v1.5.17
func (ctx *RunContext) PrintPage(items any, cols []output.Column, pg listPage) error
PrintPage prints items and then states how complete they are (see listPage).
func (*RunContext) Structured ¶ added in v1.3.1
func (ctx *RunContext) Structured() bool
Structured reports whether output should be a machine-readable dump (JSON or TOON) rather than the human table/detail view. Command handlers branch on this to suppress detail views, footers, and interactive prompts.
func (*RunContext) WriteRaw ¶ added in v1.3.4
func (ctx *RunContext) WriteRaw(body []byte) error
WriteRaw writes a non-JSON response body (e.g. a CSV/file download surfaced on Response.Raw by the *export endpoints) straight to the output writer, so shell redirection (`> file.csv`) captures the bytes verbatim instead of the canned "OK: POST ..." acknowledgment.
func (*RunContext) WriteResult ¶
func (ctx *RunContext) WriteResult(message string)
WriteResult prints a success message as plain text or JSON.
func (*RunContext) WriteResultJSON ¶ added in v1.1.0
func (ctx *RunContext) WriteResultJSON(data any, humanMessage string) error
WriteResultJSON outputs structured data in JSON or TOON mode, or a human-readable message in table mode. JSON stays indented (byte-compatible with the legacy --json path); TOON routes through the SDK marshaller.
Source Files
¶
- alert.go
- alert_event.go
- args.go
- audit.go
- automation.go
- broker_dial_unix.go
- change.go
- channel.go
- command.go
- completion.go
- config.go
- datasource_tool_output.go
- display_columns.go
- dump_commands.go
- field.go
- fieldproject.go
- gen_support.go
- generic_table.go
- identity.go
- incident.go
- incident_postmortem_content_reset.go
- insight.go
- login.go
- monit_prometheus_label_values.go
- monit_query.go
- oncall.go
- outputfields.go
- root.go
- safari_send.go
- safari_watch.go
- session.go
- suggest.go
- team.go
- template.go
- templatemeta.go
- update.go
- upload.go
- version.go
- whoami.go
- window.go
- zz_generated_a2a_agents.go
- zz_generated_account.go
- zz_generated_alert_enrichment.go
- zz_generated_alert_rules.go
- zz_generated_alerts.go
- zz_generated_analytics.go
- zz_generated_applications.go
- zz_generated_artifacts.go
- zz_generated_audit_logs.go
- zz_generated_automations.go
- zz_generated_calendars.go
- zz_generated_changes.go
- zz_generated_channels.go
- zz_generated_dashboards.go
- zz_generated_data_query.go
- zz_generated_data_sources.go
- zz_generated_dedicated_integrations.go
- zz_generated_diagnostics.go
- zz_generated_error_ingestion_rules.go
- zz_generated_facets.go
- zz_generated_im_integrations.go
- zz_generated_incidents.go
- zz_generated_integrations.go
- zz_generated_issue_preset_severity_rules.go
- zz_generated_issues.go
- zz_generated_knowledge.go
- zz_generated_licenses.go
- zz_generated_list_defaults.go
- zz_generated_manifest.go
- zz_generated_mcp_servers.go
- zz_generated_members.go
- zz_generated_notification_templates.go
- zz_generated_register.go
- zz_generated_resources.go
- zz_generated_response_help.go
- zz_generated_roles_permissions.go
- zz_generated_rule_folders.go
- zz_generated_rum_dashboards.go
- zz_generated_schedules.go
- zz_generated_session_replay.go
- zz_generated_sessions.go
- zz_generated_skills.go
- zz_generated_sourcemaps.go
- zz_generated_status_pages.go
- zz_generated_teams.go