cuxcli

package

v0.1.9 Latest Latest Go to latest Published: Jul 14, 2026 License: GPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/centrual/cuxdeck

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cuxcli is cuxdeck's only write path into cux: a thin, allowlisted bridge to the `cux` command-line tool. Every mutation the panel offers maps to exactly one CLI invocation, so cux's own validation, locking, and business rules apply unchanged — cuxdeck forks no logic.

Index ¶

Variables
type Result
- func Do(action string, args map[string]string) (Result, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrUnknownAction = errors.New("cuxcli: unknown action")

ErrUnknownAction is returned for actions outside the allowlist.

Functions ¶

This section is empty.

Types ¶

type Result ¶

type Result struct {
	OK     bool   `json:"ok"`
	Output string `json:"output"`
}

Result carries one invocation's outcome back to the panel.

func Do ¶

func Do(action string, args map[string]string) (Result, error)

Do executes one allowlisted action. Unknown actions and malformed arguments fail before anything runs.

Source Files ¶

View all Source files

cuxcli.go

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