Skip to content

INDEX.md

Latest commit

 

History

History
69 lines (55 loc) · 3.44 KB

INDEX.md

File metadata and controls

69 lines (55 loc) · 3.44 KB
Raw
type Package Index
title CoreCLI package index
description Index for the core/cli pack — CLI runtime, command registration, output, prompts, i18n, Frame TUI sub-module, and the core binary
repo core/cli
module dappco.re/go/cli

CoreCLI — package index

Repository: core/cli — github.com/dappcore/cli Module: dappco.re/go/cli (Go 1.26) Type: Library + binary (cmd/core) Depends on: dappco.re/go (core/go), golang.org/x/term, golang.org/x/sys, github.com/mattn/go-runewidth

Quick links

  • README.md — pack overview
  • CATALOG.md — auto-extracted structs and actions (generated, do not edit)
  • Primary spec: plans/code/core/go/cli/RFC.md (catalogue at plans/code/core/go/cli/RFC.catalog.md)
  • Migration spec: plans/code/core/cli/RFC.core-go-migration.md
  • AGENTS.md — agent guidance in-repo
  • CLAUDE.md — conventions in-repo

Pack contents

Area Covers
runtime/ Init/Main lifecycle, options, signals, daemon mode, exit errors
commands/ Command registration, action→CLI projection, help catalogue
output/ Semantic output, ANSI styles, glyphs, tables, trees, trackers, streams, HLCRF layout
prompts/ Prompt, Select, Confirm, Question, Choose
i18n/ cli.T, the CLI-local translation service, locale loading
frame/ Opt-in TUI sub-module (dappco.re/go/cli/frame)
cmd-core/ The core binary: config, doctor, help, pkg, ecosystem wiring, artifact tests

Command inventory (core binary)

Local built-ins, registered explicitly in go/cmd/core/main.go via cli.WithCommands:

Command path Surface
config/get, config/set, config/list, config/path cmd/core/config
doctor, doctor/checks, doctor/commands, doctor/environment, doctor/install cmd/core/doctor
help cmd/core/help
pkg/install, pkg/list, pkg/outdated, pkg/remove, pkg/search, pkg/update cmd/core/pkgcmd

Ecosystem surfaces wired into the same binary: build (dappco.re/go/build), go and qa (dappco.re/go/lint).

Registered actions (projected onto the CLI by cli.MountActions):

Action Returns
cli.version SemVer 2.0.0 version string
cli.app_name Configured application name
cli.build_info Map with version, commit, date, pre-release
demo.echo Demonstration of the action→CLI projection

Package layout

Path Contents
go/pkg/cli/ The library: 27 source files, ~4,600 lines (runtime, commands, output, prompts, layout)
go/pkg/cli/frame/ Frame TUI sub-module — own go.mod (dappco.re/go/cli/frame), bubbletea + lipgloss deps
go/pkg/cli/locales/ Framework translations (en.json), embedded via go:embed
go/pkg/i18n/ CLI-local translation service (FSLoader, magic keys)
go/internal/term/ Thin wrapper over golang.org/x/term (IsTerminal, TerminalSize)
go/cmd/core/ The core binary — own go.mod (dappco.re/go/cli/cmd/core)
go/tests/cli/ AX-10 artifact tests — Taskfile per command surface, asserts on the built binary