Reference

The following reference material describes all of Charmcraft’s key components and processes. It includes commands, extensions, charm project files, and more.

Command-line reference

The following pages document all of Charmcraft’s commands, including their usage, options, and arguments:

• Lifecycle commands

• Store commands

• Account commands

• Charm or bundle commands

• Library commands

• Extensions-related commands

• Other commands

Files

In the context of Charmcraft, a file refers to any file in a project that can be initialized or packed. The files are documented in the following pages:

• actions.yaml file

• bundle.yaml file

• charmcraft.yaml file

• config.yaml file

• CONTRIBUTING.md file

• dispatch

• icon.svg file

• <libname>.py file

• LICENSE file

• lxd-profile.yaml file

• manifest.yaml file

• metadata.yaml file

• pyproject.toml file

• README.md file

• requirements-dev.txt file

• requirements.txt file

• src/charm.py file

• src/<workload>.py file

• tests/integration/test_charm.py file

• tests/unit/test_charm.py file

• tox.ini file

Plugins and extensions

Extensions help initialize your project with template YAML and Ops-powered Python to remove the boilerplate steps of crafting charms for Django, FastAPI, Flask, and Go applications.

• Profile

• Extensions

• Plugins