Documentation
¶
Overview ¶
Package cli implements the brainjar command-line interface on top of cobra. Commands are registered against a single root command; each command resolves `--home`, loads config, and opens a LocalBackend.
Index ¶
- Constants
- Variables
- func Execute(ctx context.Context, app *App, args []string) int
- func ExitCodeFor(err error) int
- func NewRootCmd(app *App) *cobra.Command
- func NewUsageError(format string, args ...any) error
- func PrintError(w io.Writer, err error, jsonOut bool)
- func StdinIsTTY() bool
- type App
- type IO
- type UsageError
Constants ¶
const ( ExitOK = 0 ExitGeneric = 1 ExitBadUsage = 2 ExitNotFound = 3 ExitConflict = 4 )
Exit codes — stable contract published to scripts and CI.
Variables ¶
var Version = "dev"
Version is the brainjar binary version. The release workflow overrides this via -ldflags -X at build time with the git tag. Must be a var, not a const — -X can only inject into vars.
Functions ¶
func Execute ¶
Execute runs the CLI with the given args (usually os.Args[1:]) and returns the exit code. Errors are printed to app.IO.Err; success output has already been written by the command that ran.
func ExitCodeFor ¶
ExitCodeFor maps any error returned by a command to the process exit code the CLI should terminate with.
func NewRootCmd ¶
NewRootCmd builds the cobra tree and returns the root command.
func NewUsageError ¶
NewUsageError returns a UsageError with the given message.
func PrintError ¶
PrintError writes the error to w. In text mode it writes a plain line (plus hint/invalid-refs indented on following lines); in JSON mode it writes a single structured envelope matching apperrors.ToHTTP.
func StdinIsTTY ¶
func StdinIsTTY() bool
StdinIsTTY reports whether the real process stdin is a terminal. CLI commands use this to fail fast when content is expected on a pipe but the user invoked the command interactively without flags.
Types ¶
type App ¶
type App struct {
IO IO
// contains filtered or unexported fields
}
App holds global CLI state shared across commands.
func (*App) Backend ¶
func (a *App) Backend() (*backend.LocalBackend, error)
Backend opens a LocalBackend against the resolved home. The caller is responsible for calling Close() when done.
func (*App) EmitJSON ¶
EmitJSON writes v to stdout as a single JSON document. No-op when --json is not set — call EmitText for human output instead.
func (*App) EmitText ¶
EmitText writes a human-readable line to stdout. No-op when --json is set — agents consume EmitJSON output instead.
func (*App) ReadContent ¶
ReadContent returns the content for a `create` command. Precedence: --content > --file > stdin. Errors if both flags are set, or if neither is set and stdin is a TTY.
func (*App) ResolveHome ¶
ResolveHome returns the resolved home directory, honoring the flag and environment. Safe to call from any command's RunE.
type IO ¶
IO holds the in/out/err streams a command reads and writes. Tests substitute buffers; the root command wires stdin/stdout/stderr.
type UsageError ¶
type UsageError struct{ Msg string }
UsageError marks a cobra-level usage problem (unknown flag, missing positional arg, mutually-exclusive flags). It maps to ExitBadUsage.
func (*UsageError) Error ¶
func (e *UsageError) Error() string
Source Files