API

Complete API reference for cmdkit.

• cmdkit.app
  • Reference
    • Application
      • Application.interface
      • Application.ALLOW_NOARGS
      • Application.exceptions
      • Application.log_critical
      • Application.log_exception
      • Application.from_cmdline()
      • Application.from_namespace()
      • Application.main()
      • Application.run()
      • Application.__enter__()
      • Application.__exit__()
      • Application.shared
      • Application.handle_usage()
      • Application.handle_help()
      • Application.handle_version()
    • ApplicationGroup
      • ApplicationGroup.shared
      • ApplicationGroup.ALLOW_PARSE
    • exit_status
• cmdkit.cli
  • Reference
    • Interface
    • HelpOption
    • VersionOption
    • ArgumentError
• cmdkit.namespace
  • Reference
    • Namespace
      • Namespace.update()
      • Namespace.from_local()
      • Namespace.to_local()
      • Namespace.from_yaml()
      • Namespace.from_toml()
      • Namespace.from_json()
      • Namespace.to_yaml()
      • Namespace.to_toml()
      • Namespace.to_json()
      • Namespace.from_env()
      • Namespace.to_env()
      • Namespace.duplicates()
      • Namespace.whereis()
    • Environ
      • Environ.expand()
      • Environ.flatten()
      • Environ.export()
• cmdkit.config
  • Reference
    • Configuration
      • Configuration.namespaces
      • Configuration.extend()
      • Configuration.from_local()
      • Configuration.from_context()
      • Configuration.which()
      • Configuration.duplicates()
      • Configuration.whereis()
      • Configuration.update()
• cmdkit.logging
  • Reference
    • Logger
      • Logger.with_name()
      • Logger.default()
    • LogRecord
      • LogRecord.app_id
      • LogRecord.hostname
      • LogRecord.hostname_short
      • LogRecord.relative_name
      • LogRecord.ansi_level
      • LogRecord.ansi_reset
      • LogRecord.ansi_bold
      • LogRecord.ansi_faint
      • LogRecord.ansi_italic
      • LogRecord.ansi_underline
      • LogRecord.ansi_black
      • LogRecord.ansi_red
      • LogRecord.ansi_green
      • LogRecord.ansi_yellow
      • LogRecord.ansi_blue
      • LogRecord.ansi_magenta
      • LogRecord.ansi_cyan
      • LogRecord.ansi_white
      • LogRecord.elapsed
      • LogRecord.elapsed_ms
      • LogRecord.elapsed_delta
      • LogRecord.elapsed_hms
    • HOSTNAME
    • HOSTNAME_SHORT
    • INSTANCE
    • level_by_name
    • logging_styles
    • DEFAULT_LOGGING_STYLE
    • NOTSET
    • DEVEL
    • TRACE
    • DEBUG
    • INFO
    • NOTICE
    • WARNING
    • ERROR
    • CRITICAL
• cmdkit.ansi
  • Reference
    • NO_COLOR
    • FORCE_COLOR
    • Ansi
      • Ansi.NULL
      • Ansi.RESET
      • Ansi.BOLD
      • Ansi.FAINT
      • Ansi.ITALIC
      • Ansi.UNDERLINE
      • Ansi.BLACK
      • Ansi.RED
      • Ansi.GREEN
      • Ansi.YELLOW
      • Ansi.BLUE
      • Ansi.MAGENTA
      • Ansi.CYAN
      • Ansi.WHITE
    • format_ansi()
    • bold()
    • faint()
    • italic()
    • underline()
    • black()
    • red()
    • green()
    • yellow()
    • blue()
    • magenta()
    • cyan()
    • white()
    • colorize_usage()
• cmdkit.platform
  • Platform-Specific Paths
    • Windows
    • macOS
    • Linux / POSIX
  • Reference
    • AppContext
      • AppContext.default()
      • AppContext.cwd
      • AppContext.home
      • AppContext.name
      • AppContext.path
      • AppContext.default_site
      • AppContext.default_path