hzDocs
hzDocs
文章 / 文档hedzr.com首页

cmdr series

介绍 cmdr

Guide

你的首个 CLI app更适合工程实践的版本
循序渐进
基本概念
命令命令:执行外部程序命令:预设参数命令:重定向命令:动态命令清单命令:在配置文件中定义别名清单命令:事件响应函数标志标志:必须项标志:可翻转组标志:枚举值标志:`Head -1` 风格标志:调用外部工具获得输入标志:自动否定标志:加号 `+` 前缀标志:事件响应函数解析结果内建命令和标志帮助子系统可共享共存的 app 实例辨析顶级函数WithOptsBackstage
如何……
Auto-close the ClosersRead config into structUsing is DetectorsUsing Store

References

What's New
Packages

Others

Examples
Blueprint
产品发布
产品发布之前
介绍 cmdr-cxx

Guide

cmdr supports

Intro

Guide

More features

References

Others

evendeep(-go)

Guide

Usagesdeepcopydeepdiffdeepequal
logg/slog(-go)

Guide

Guide

others

Components
trie-cxx

Guide

Guide

links

On Github

顶级函数

Package Level Functions...

cmdr 包级函数

  • New/Create app
    • cmdr.New(opts ...cli.Opt) cli.App

    • cmdr.Create(appName, version, author, desc string, opts ...cli.Opt) Creator

    • Information

      • cmdr.App() cli.Runner
      • cmdr.AppName() string
      • cmdr.AppVersion() string
      • cmdr.AppDescription() string
      • cmdr.AppDescriptionLong() string
      • cmdr.CmdLines() []string
  • Errors
    • cmdr.Error() errors.Error
    • cmdr.Recycle(errs ...error)
  • Parsing
    • cmdr.Parsed() bool
    • cmdr.ParsedLastCmd() cli.Cmd
    • cmdr.ParsedCommands() []cli.Cmd
    • cmdr.ParsedPositionalArgs() []string
  • Store
    • cmdr.Store(prefix ...string) store.Store
    • cmdr.Set(prefix ...string) store.Store
    • cmdr.LoadedSources() []cli.LoadedSources
  • Utilities
    • cmdr.RemoveOrderedPrefix(s string) string
  • Directories
    • cmdr.DataDir(base ...string) string
    • cmdr.ConfigDir(base ...string) string
    • cmdr.CacheDir(base ...string) string
    • cmdr.HomeDir() string
    • cmdr.TempDir(base ...string) string
    • cmdr.TempFileName(fileNamePattern, defaultFileName string, base ...string) (filename string)
    • cmdr.VarLogDir(base ...string) string
    • cmdr.VarRunDir(base ...string) string
    • cmdr.UsrLibDir(base ...string) string
  • Backwords Compartibilities
    • cmdr.Exec(rootCmd *cli.RootCommand, opts ...cli.Opt) (err error)

Creator

type Creator interface {
	WithOpts(opts ...cli.Opt) Creator
	// WithAdders receives a couple of cli.CmdAdder adders
	// which can initialize a command standalone.
	WithAdders(adders ...cli.CmdAdder) Creator
	// WithBuilders receives a couple of callbacks of cli.CommandBuilder
	// which can initialize command and flag.
	WithBuilders(builders ...func(b cli.CommandBuilder)) Creator
	// With a callback, you can initialize commands and
	// flags by app object directly.
	With(cb func(app cli.App)) Creator

	// Build creates the final app object and stop the
	// building sequence of a builder pattern.
	Build() (app cli.App)
}

额外的话题

With Options

Builtin Commands

What is Next?

Components

Components

On Github

How is this guide?

最后更新于

目录

cmdr 包级函数
Creator
额外的话题