Documentation
¶
Index ¶
- Variables
- type Category
- type CategoryItem
- type ConnectionInitFormValues
- type ConnectionsInitPage
- type ConnectionsManagePage
- func (m ConnectionsManagePage) GetActiveConnection() *configuration.RoverConnection
- func (m ConnectionsManagePage) GetNonActiveConnections() []configuration.RoverConnection
- func (m ConnectionsManagePage) Init() tea.Cmd
- func (m ConnectionsManagePage) Update(msg tea.Msg) (pageModel, tea.Cmd)
- func (m ConnectionsManagePage) View() string
- type FirstOpenPage
- type InfoPage
- type MainModel
- type OfficialRelease
- type PipelineConfiguratorKeyMap
- type PipelineConfiguratorPage
- type PipelineDetailsKeyMap
- type PipelineDetailsPage
- type PipelineDownloadDefaultPage
- type PipelineLogsKeyMap
- type PipelineLogsPage
- type PipelineManagerPage
- type PipelineOverviewKeyMap
- type PipelineOverviewPage
- type PipelineOverviewServiceInfo
- type PipelineOverviewSummary
- type PipelineOverviewTab
- type PipelineService
- type ServiceDetails
- type ServiceInitPage
- type ServiceSyncInstructionsPage
- type ServicesListPage
- type ServicesOverviewPage
- type ServicesSyncPage
- type ServicesUpdateKeyMap
- type ServicesUpdatePage
- type ShutdownRoverPage
- type StartPage
- type TemplatePage
- type UpdatableItem
- type UpdateListItemDelegate
- type UtilitiesPage
Constants ¶
This section is empty.
Variables ¶
var PipelineLogsKeysRegular = PipelineLogsKeyMap{ Up: key.NewBinding( key.WithKeys("k", "up"), key.WithHelp("↑/k", "up"), ), Down: key.NewBinding( key.WithKeys("j", "down"), key.WithHelp("↓/j", "down"), ), Retry: key.NewBinding( key.WithKeys("r"), key.WithHelp("r", "refetch"), ), Quit: key.NewBinding( key.WithKeys("q"), key.WithHelp("q", "quit"), ), }
Shown when the services are being updated
Functions ¶
This section is empty.
Types ¶
type CategoryItem ¶ added in v1.3.0
type CategoryItem struct {
// contains filtered or unexported fields
}
type ConnectionInitFormValues ¶
type ConnectionInitFormValues struct {
// contains filtered or unexported fields
}
type ConnectionsInitPage ¶
type ConnectionsInitPage struct {
// contains filtered or unexported fields
}
func NewConnectionsInitPage ¶
func NewConnectionsInitPage(val *ConnectionInitFormValues) ConnectionsInitPage
func (ConnectionsInitPage) Init ¶
func (m ConnectionsInitPage) Init() tea.Cmd
func (ConnectionsInitPage) Update ¶
func (m ConnectionsInitPage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (ConnectionsInitPage) View ¶
func (m ConnectionsInitPage) View() string
type ConnectionsManagePage ¶
type ConnectionsManagePage struct {
// contains filtered or unexported fields
}
func NewConnectionsManagePage ¶
func NewConnectionsManagePage() ConnectionsManagePage
func (ConnectionsManagePage) GetActiveConnection ¶ added in v1.3.0
func (m ConnectionsManagePage) GetActiveConnection() *configuration.RoverConnection
func (ConnectionsManagePage) GetNonActiveConnections ¶ added in v1.3.0
func (m ConnectionsManagePage) GetNonActiveConnections() []configuration.RoverConnection
func (ConnectionsManagePage) Init ¶
func (m ConnectionsManagePage) Init() tea.Cmd
func (ConnectionsManagePage) Update ¶
func (m ConnectionsManagePage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (ConnectionsManagePage) View ¶
func (m ConnectionsManagePage) View() string
type FirstOpenPage ¶ added in v1.3.0
type FirstOpenPage struct {
// contains filtered or unexported fields
}
func NewFirstOpenPage ¶ added in v1.3.0
func NewFirstOpenPage() FirstOpenPage
func (FirstOpenPage) Init ¶ added in v1.3.0
func (m FirstOpenPage) Init() tea.Cmd
func (FirstOpenPage) Update ¶ added in v1.3.0
func (m FirstOpenPage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (FirstOpenPage) View ¶ added in v1.3.0
func (m FirstOpenPage) View() string
type InfoPage ¶
type InfoPage struct {
// contains filtered or unexported fields
}
func NewInfoPage ¶
func NewInfoPage() InfoPage
type MainModel ¶
type MainModel struct {
// contains filtered or unexported fields
}
This is the main model that will be used to render all sub-models
func CliRootScreen ¶ added in v1.6.0
func RootScreen ¶
func (MainModel) SwitchScreen ¶
This function is used to switch between screens, the caller should supply the "route" taken so far to get to this screen, so that users can return to the previous screen
type OfficialRelease ¶
type OfficialRelease struct {
NewVersion string // The new version of the source
}
replace with download manager
type PipelineConfiguratorKeyMap ¶
type PipelineConfiguratorKeyMap struct {
Retry key.Binding
Confirm key.Binding
Switch key.Binding // switch table focus
Remove key.Binding // remove service from pipeline
Back key.Binding // go back one level
Save key.Binding // save the pipeline
Quit key.Binding
Refetch key.Binding
}
Keys to navigate
func (PipelineConfiguratorKeyMap) FullHelp ¶
func (k PipelineConfiguratorKeyMap) FullHelp() [][]key.Binding
func (PipelineConfiguratorKeyMap) ShortHelp ¶
func (k PipelineConfiguratorKeyMap) ShortHelp() []key.Binding
type PipelineConfiguratorPage ¶
type PipelineConfiguratorPage struct {
// contains filtered or unexported fields
}
func NewPipelineConfiguratorPage ¶
func NewPipelineConfiguratorPage() PipelineConfiguratorPage
func (PipelineConfiguratorPage) Init ¶
func (m PipelineConfiguratorPage) Init() tea.Cmd
func (PipelineConfiguratorPage) Update ¶
func (m PipelineConfiguratorPage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (PipelineConfiguratorPage) View ¶
func (m PipelineConfiguratorPage) View() string
type PipelineDetailsKeyMap ¶
Keys to navigate
func (PipelineDetailsKeyMap) FullHelp ¶
func (k PipelineDetailsKeyMap) FullHelp() [][]key.Binding
func (PipelineDetailsKeyMap) ShortHelp ¶
func (k PipelineDetailsKeyMap) ShortHelp() []key.Binding
type PipelineDetailsPage ¶
type PipelineDetailsPage struct {
// contains filtered or unexported fields
}
func NewPipelineDetailsPage ¶
func NewPipelineDetailsPage(s PipelineOverviewServiceInfo) PipelineDetailsPage
func (PipelineDetailsPage) Init ¶
func (m PipelineDetailsPage) Init() tea.Cmd
func (PipelineDetailsPage) Update ¶
func (m PipelineDetailsPage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (PipelineDetailsPage) View ¶
func (m PipelineDetailsPage) View() string
type PipelineDownloadDefaultPage ¶ added in v1.3.0
type PipelineDownloadDefaultPage struct {
// contains filtered or unexported fields
}
func NewPipelineDownloadDefaultPage ¶ added in v1.3.0
func NewPipelineDownloadDefaultPage() PipelineDownloadDefaultPage
func (PipelineDownloadDefaultPage) Init ¶ added in v1.3.0
func (m PipelineDownloadDefaultPage) Init() tea.Cmd
func (PipelineDownloadDefaultPage) Update ¶ added in v1.3.0
func (m PipelineDownloadDefaultPage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (PipelineDownloadDefaultPage) View ¶ added in v1.3.0
func (m PipelineDownloadDefaultPage) View() string
type PipelineLogsKeyMap ¶
type PipelineLogsKeyMap struct {
Up key.Binding
Down key.Binding
Retry key.Binding
Confirm key.Binding
Quit key.Binding
}
Keys to navigate
func (PipelineLogsKeyMap) FullHelp ¶
func (k PipelineLogsKeyMap) FullHelp() [][]key.Binding
func (PipelineLogsKeyMap) ShortHelp ¶
func (k PipelineLogsKeyMap) ShortHelp() []key.Binding
type PipelineLogsPage ¶
type PipelineLogsPage struct {
// contains filtered or unexported fields
}
func NewPipelineLogsPage ¶
func NewPipelineLogsPage(service string, author string, version string) PipelineLogsPage
func (PipelineLogsPage) Init ¶
func (m PipelineLogsPage) Init() tea.Cmd
func (PipelineLogsPage) View ¶
func (m PipelineLogsPage) View() string
type PipelineManagerPage ¶ added in v1.3.0
type PipelineManagerPage struct {
// contains filtered or unexported fields
}
func NewPipelineManagerPage ¶ added in v1.3.0
func NewPipelineManagerPage() PipelineManagerPage
func (PipelineManagerPage) Init ¶ added in v1.3.0
func (m PipelineManagerPage) Init() tea.Cmd
func (PipelineManagerPage) Update ¶ added in v1.3.0
func (m PipelineManagerPage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (PipelineManagerPage) View ¶ added in v1.3.0
func (m PipelineManagerPage) View() string
type PipelineOverviewKeyMap ¶
type PipelineOverviewKeyMap struct {
Retry key.Binding
Toggle key.Binding // start/stop pipeline
Logs key.Binding
Details key.Binding
Configure key.Binding
Quit key.Binding
}
Keys to navigate
func (PipelineOverviewKeyMap) FullHelp ¶
func (k PipelineOverviewKeyMap) FullHelp() [][]key.Binding
func (PipelineOverviewKeyMap) ShortHelp ¶
func (k PipelineOverviewKeyMap) ShortHelp() []key.Binding
type PipelineOverviewPage ¶
type PipelineOverviewPage struct {
// contains filtered or unexported fields
}
func NewPipelineOverviewPage ¶
func NewPipelineOverviewPage() PipelineOverviewPage
func (PipelineOverviewPage) Init ¶
func (m PipelineOverviewPage) Init() tea.Cmd
func (PipelineOverviewPage) Update ¶
func (m PipelineOverviewPage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (PipelineOverviewPage) View ¶
func (m PipelineOverviewPage) View() string
type PipelineOverviewServiceInfo ¶
type PipelineOverviewServiceInfo struct {
Name string
Version string
Author string
Configuration openapi.ServicesAuthorServiceVersionGet200Response
}
type PipelineOverviewSummary ¶
type PipelineOverviewSummary struct {
// Basic pipeline GET request
Pipeline openapi.PipelineGet200Response
// Information about services specifically
Services []PipelineOverviewServiceInfo
// Status from roverd (for CPU and memory usage)
Status openapi.StatusGet200Response
}
type PipelineOverviewTab ¶
type PipelineOverviewTab int
const ( PipelineOverviewTabNone PipelineOverviewTab = iota PipelineOverviewTabServiceDetails PipelineOverviewTabLogs )
type PipelineService ¶ added in v1.3.0
type PipelineService struct {
// contains filtered or unexported fields
}
type ServiceDetails ¶ added in v1.3.0
type ServiceDetails struct {
// contains filtered or unexported fields
}
type ServiceInitPage ¶
type ServiceInitPage struct {
// contains filtered or unexported fields
}
func NewServiceInitPage ¶
func NewServiceInitPage() ServiceInitPage
func (ServiceInitPage) Init ¶
func (m ServiceInitPage) Init() tea.Cmd
func (ServiceInitPage) View ¶
func (m ServiceInitPage) View() string
type ServiceSyncInstructionsPage ¶ added in v1.6.0
type ServiceSyncInstructionsPage struct {
// contains filtered or unexported fields
}
func NewServiceSyncInstructionsPage ¶ added in v1.6.0
func NewServiceSyncInstructionsPage() ServiceSyncInstructionsPage
func (ServiceSyncInstructionsPage) Init ¶ added in v1.6.0
func (m ServiceSyncInstructionsPage) Init() tea.Cmd
func (ServiceSyncInstructionsPage) Update ¶ added in v1.6.0
func (m ServiceSyncInstructionsPage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (ServiceSyncInstructionsPage) View ¶ added in v1.6.0
func (m ServiceSyncInstructionsPage) View() string
type ServicesListPage ¶
type ServicesListPage struct {
// contains filtered or unexported fields
}
func NewServicesListPage ¶
func NewServicesListPage() ServicesListPage
func (ServicesListPage) Init ¶
func (m ServicesListPage) Init() tea.Cmd
func (ServicesListPage) View ¶
func (m ServicesListPage) View() string
type ServicesOverviewPage ¶
type ServicesOverviewPage struct {
// contains filtered or unexported fields
}
func NewServicesOverviewPage ¶
func NewServicesOverviewPage() ServicesOverviewPage
func (ServicesOverviewPage) Init ¶
func (m ServicesOverviewPage) Init() tea.Cmd
func (ServicesOverviewPage) Update ¶
func (m ServicesOverviewPage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (ServicesOverviewPage) View ¶
func (m ServicesOverviewPage) View() string
type ServicesSyncPage ¶
type ServicesSyncPage struct {
// contains filtered or unexported fields
}
func NewServicesSyncPage ¶
func NewServicesSyncPage(paths []string) ServicesSyncPage
func (ServicesSyncPage) Init ¶
func (m ServicesSyncPage) Init() tea.Cmd
func (ServicesSyncPage) View ¶
func (m ServicesSyncPage) View() string
type ServicesUpdateKeyMap ¶
type ServicesUpdateKeyMap struct {
Retry key.Binding
Confirm key.Binding
Quit key.Binding
Queue key.Binding
QueueAll key.Binding
QueueNone key.Binding
}
ServicesUpdateKeyMap defines a set of keybindings. To work for help it must satisfy key.Map
func (ServicesUpdateKeyMap) FullHelp ¶
func (k ServicesUpdateKeyMap) FullHelp() [][]key.Binding
FullHelp returns keybindings for the expanded help view. It's part of the key.Map interface.
func (ServicesUpdateKeyMap) ShortHelp ¶
func (k ServicesUpdateKeyMap) ShortHelp() []key.Binding
ShortHelp returns keybindings to be shown in the mini help view. It's part of the key.Map interface.
type ServicesUpdatePage ¶
type ServicesUpdatePage struct {
// contains filtered or unexported fields
}
func NewServicesUpdatePage ¶
func NewServicesUpdatePage() ServicesUpdatePage
func (ServicesUpdatePage) Init ¶
func (m ServicesUpdatePage) Init() tea.Cmd
func (ServicesUpdatePage) Update ¶
func (m ServicesUpdatePage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (ServicesUpdatePage) View ¶
func (m ServicesUpdatePage) View() string
type ShutdownRoverPage ¶ added in v1.3.0
type ShutdownRoverPage struct {
// contains filtered or unexported fields
}
func NewShutdownRoverPage ¶ added in v1.3.0
func NewShutdownRoverPage() ShutdownRoverPage
func (ShutdownRoverPage) Init ¶ added in v1.3.0
func (m ShutdownRoverPage) Init() tea.Cmd
func (ShutdownRoverPage) Update ¶ added in v1.3.0
func (m ShutdownRoverPage) Update(msg tea.Msg) (pageModel, tea.Cmd)
func (ShutdownRoverPage) View ¶ added in v1.3.0
func (m ShutdownRoverPage) View() string
type StartPage ¶
type StartPage struct {
// contains filtered or unexported fields
}
func NewStartPage ¶
func NewStartPage() StartPage
type TemplatePage ¶
type TemplatePage struct {
// contains filtered or unexported fields
}
func NewTemplatePage ¶
func NewTemplatePage() TemplatePage
func (TemplatePage) Init ¶
func (m TemplatePage) Init() tea.Cmd
func (TemplatePage) View ¶
func (m TemplatePage) View() string
type UpdatableItem ¶
type UpdatableItem struct {
RoverdSource openapi.SourcesGet200ResponseInner
Release OfficialRelease
Queued bool // whether the user wants to update this source
}
func (UpdatableItem) FilterValue ¶
func (i UpdatableItem) FilterValue() string
type UpdateListItemDelegate ¶
type UpdateListItemDelegate struct{}
func (UpdateListItemDelegate) Height ¶
func (d UpdateListItemDelegate) Height() int
func (UpdateListItemDelegate) Spacing ¶
func (d UpdateListItemDelegate) Spacing() int
type UtilitiesPage ¶
type UtilitiesPage struct {
// contains filtered or unexported fields
}
func NewUtilitiesPage ¶
func NewUtilitiesPage() UtilitiesPage
func (UtilitiesPage) Init ¶
func (m UtilitiesPage) Init() tea.Cmd
func (UtilitiesPage) View ¶
func (m UtilitiesPage) View() string
Source Files
¶
- connections_init.go
- connections_manage.go
- first_open.go
- info.go
- overview.go
- pipeline_configurator.go
- pipeline_default.go
- pipeline_details.go
- pipeline_logs.go
- pipeline_manager.go
- pipeline_overview.go
- root.go
- services_init.go
- services_list.go
- services_overview.go
- services_sync.go
- services_sync_instructions.go
- services_update.go
- shutdown.go
- template.go
- utils.go