cli

package

v0.1.0 Latest Latest Go to latest Published: Jun 14, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Details

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

Repository

github.com/tamnd/wikipedia-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cli builds the wiki command tree on top of the wiki library.

Index ¶

Variables
func Root() *cobra.Command
type App
- func (a *App) Client() (*wiki.Client, error)
type Format
type Output
type Row

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Version = "dev"
	Commit  = "none"
	Date    = "unknown"
)

Build metadata, set via -ldflags at release time.

Functions ¶

func Root ¶

func Root() *cobra.Command

Root builds the root command and its whole subtree.

Types ¶

type App ¶

type App struct {
	Cfg   wiki.Config
	Cache *wiki.Cache
	Out   *Output

	Limit int
	// contains filtered or unexported fields
}

App carries the resolved configuration and shared clients for a command run.

func (*App) Client ¶

func (a *App) Client() (*wiki.Client, error)

Client returns the resolved wiki client or the resolution error (bad project/host). Commands that need network access call this first.

type Format ¶

type Format string

Format is an output encoding.

const (
	FormatAuto  Format = "auto"
	FormatTable Format = "table"
	FormatJSON  Format = "json"
	FormatJSONL Format = "jsonl"
	FormatCSV   Format = "csv"
	FormatTSV   Format = "tsv"
	FormatURL   Format = "url"
	FormatRaw   Format = "raw"
)

type Output ¶

type Output struct {
	// contains filtered or unexported fields
}

Output renders rows in the selected format. A single Output instance handles a whole command run, so streaming formats can write incrementally.

func (*Output) Emit ¶

func (o *Output) Emit(r Row) error

Emit renders one row.

func (*Output) Flush ¶

func (o *Output) Flush() error

Flush finalises buffered formats. Call once at the end of a command.

func (*Output) Format ¶

func (o *Output) Format() Format

Format returns the resolved output format.

func (*Output) Raw ¶

func (o *Output) Raw(b []byte) error

Raw writes bytes straight to stdout (for content output).

type Row ¶

type Row struct {
	Cols  []string
	Vals  []string
	Value any
}

Row is one output record: an ordered set of named columns plus the original value (used by json/jsonl and templates).

Source Files ¶

View all Source files

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