• Logo
    Craft CLI
  • github.com/canonical/craft-cli
  • More resources
    • Matrix
    • GitHub
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Craft CLI documentation
Craft CLI documentation
  • Tutorials
    • Run a command based application with craft-cli
  • How-to guides
    • Use a different logfile structure than the default
    • End the application with different return codes
    • Have a hidden option in a command
    • Raise more informational errors
    • Set a default command for the application
    • Create unit tests for code that uses Craft CLI’s Emitter
    • Define and use other global arguments
    • Use the completion module
    • Temporarily allow another application to control the terminal
  • Reference
    • craft_cli package
      • craft_cli.completion package
        • craft_cli.completion.completion module
      • craft_cli.dispatcher module
      • craft_cli.errors module
      • craft_cli.helptexts module
      • craft_cli.messages module
      • craft_cli.printer module
      • craft_cli.pytest_plugin module
      • craft_cli.utils module
  • Explanation
    • Documentation
    • About the appropriate mode to initiate emit
    • How Craft CLI manage the application logs
    • Global and command specific arguments
    • Group of commands
    • What are hidden and common commands?
    • Presenting messages to the user
  • Changelog
Back to top
Contribute to this page

Explanation¶

Explanations provide a wider perspective of Craft CLI. They aid in understanding the concepts and relationships of Craft CLI as a complete system.

  • Documentation
  • About the appropriate mode to initiate emit
  • How Craft CLI manage the application logs
  • Global and command specific arguments
  • Group of commands
  • What are hidden and common commands?
  • Presenting messages to the user
© 2021-2026 Canonical Ltd.
This page is licensed under LGPL-3.0
Last updated on Oct 20, 2026
Contents
  • Explanation