How-to guides

Charmcraft’s how-to guides provide comprehensive, step-by-step instructions for the most common charm development tasks – from initializing a project to publishing it on Charmhub.

Install Charmcraft

Charmcraft can be installed in just a few short steps, regardless of if you are installing on Linux, macOS, or an isolated environment. Specific instructions for installing Charmcraft and setting up your build container can be found in Manage Charmcraft.

Craft charms

Nearly every aspect of your charm can be configured to suit the needs of the application you are charming. Once you initialize the project with either the default profile or one of Charmcraft’s web app extensions, you can modify a charm’s YAML and Ops-powered Python to include any necessary libraries, parts, or other assets your application may require.

• Manage charms

• Manage builds

• Manage 12-factor app charms

• Manage parts

• Manage resources

• Manage libraries

• Manage extensions

• Manage charm bundles

Publish charms and manage releases

When you’re ready to distribute your charm, Charmcraft provides commands to register it, publish it to Charmhub, and manage its releases.

• Manage the current Charmhub user

• Manage names

• Manage icons

• Manage charm revisions

• Manage tracks

• Manage channels

Migrate between plugins

Certain charms may benefit from using a plugin other than the default Charm plugin. For instructions on migrating away from the default Charm plugin, refer to the appropriate migration guide for your charm:

• Migrate from the Charm plugin to the Poetry plugin

• Migrate from the Charm plugin to the Python plugin

• Migrate from the Charm plugin to the uv plugin