cmd

package
v0.22.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 26, 2026 License: Apache-2.0 Imports: 47 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Execute

func Execute(ctx context.Context) error

func InstallMCPForClient

func InstallMCPForClient(opts InstallOptions) error

InstallMCPForClient installs an MCP server configuration for the specified client. This is a generic, configurable function exported for use by external projects via pkg/mcpinstall. Required options: ServerName, Command, Args must all be provided.

Types

type ArgsLenAtDashProvider

type ArgsLenAtDashProvider interface {
	ArgsLenAtDash() int
}

ArgsLenAtDashProvider defines the interface for getting ArgsLenAtDash

type ClientInfo

type ClientInfo struct {
	// Name is the human-readable display name (e.g., "Claude Code", "Cursor")
	Name string
	// ClientName is the identifier to use in InstallOptions.ClientName (e.g., "claude-code", "cursor")
	ClientName string
}

ClientInfo contains information about a supported MCP client.

func SupportedClients

func SupportedClients() []ClientInfo

SupportedClients returns information about all supported MCP clients.

type ClientOption

type ClientOption struct {
	Name       string // Display name
	ClientName string // Client name to pass to installMCPForClient
}

ClientOption represents a client choice for interactive selection

type CreateRoleResult

type CreateRoleResult struct {
	RoleName         string   `json:"role_name"`
	ReadOnly         bool     `json:"read_only,omitempty"`
	StatementTimeout string   `json:"statement_timeout,omitempty"`
	FromRoles        []string `json:"from_roles,omitempty"`
}

CreateRoleResult represents the output of a create role operation

type InstallOptions

type InstallOptions struct {
	// ClientName is the name of the client to configure (required)
	ClientName string
	// ServerName is the name to register the MCP server as (required)
	ServerName string
	// Command is the path to the MCP server binary (required)
	Command string
	// Args are the arguments to pass to the MCP server binary (required)
	Args []string
	// CreateBackup creates a backup of existing config files before modification
	CreateBackup bool
	// CustomConfigPath overrides the default config file location
	CustomConfigPath string
}

InstallOptions configures the MCP server installation behavior

type MCPClient

type MCPClient string

MCPClient represents our internal client types

const (
	ClaudeCode  MCPClient = "claude-code"
	Cursor      MCPClient = "cursor" // Both the IDE and the CLI
	Windsurf    MCPClient = "windsurf"
	Codex       MCPClient = "codex"
	Gemini      MCPClient = "gemini"
	VSCode      MCPClient = "vscode"
	Antigravity MCPClient = "antigravity"
	KiroCLI     MCPClient = "kiro-cli"
)

type MCPServerConfig

type MCPServerConfig struct {
	Command string   `json:"command"`
	Args    []string `json:"args"`
}

MCPServerConfig represents the MCP server configuration

type OutputService

type OutputService struct {
	api.Service
	common.ConnectionDetails
	ConnectionString string `json:"connection_string,omitempty"`
	ConsoleURL       string `json:"console_url,omitempty"`
}

OutputService represents a service with computed fields for output

type VersionOutput

type VersionOutput struct {
	Version         string `json:"version"`
	BuildTime       string `json:"build_time"`
	GitCommit       string `json:"git_commit"`
	GoVersion       string `json:"go_version"`
	Platform        string `json:"platform"`
	LatestVersion   string `json:"latest_version,omitempty"`
	UpdateAvailable *bool  `json:"update_available,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL