Reference

References describe the structure and function of the individual components in Charmcraft.

Commands

Charmcraft is operated from the command line, with a command for each function.

• Lifecycle commands

• Store commands

• Account commands

• Charm commands

• Library commands

• Extension commands

• Other commands

Files

The following files are initialized and packed in a Charmcraft project:

Project file

• charmcraft.yaml file

Project information

• LICENSE file

• README.md file

• CONTRIBUTING.md file

• icon.svg file

Python modules

• src/charm.py file

• src/<workload>.py file

• <libname>.py file

Dependency management

• pyproject.toml file

• requirements.txt file

• uv.lock file

Testing

• tests/integration/conftest.py file

• tests/integration/test_charm.py file

• tests/unit/test_charm.py file

Plugins and extensions

Extensions initialize your project with YAML and Ops catered to supported web frameworks.

• Profile

• Extensions

• Plugins