Skip to main content

The main tool to build, upload, and develop in general the Juju charms.

Project description

Charmcraft

Charmcraft Documentation Status Tests Spread Weekly Spread

Charmcraft is the command-line tool for initializing, packaging, and publishing charms, the software operators used by Juju. With Charmcraft, you can bypass the boilerplate steps of crafting a charm and focus on what matters — building scalable, configurable, and easy-to-deploy applications for Juju.

Basic usage

Charmcraft provides commands to streamline every step of the charm development process, from initializing your charm project to releasing it on Charmhub.

In your project's root directory, initialize your charm project with basic template content by running:

charmcraft init

Once you've configured your project to suit the needs of the application you're charming, build the charm by running:

charmcraft pack

If you're ready to distribute your charm, you can register its name on Charmhub with:

charmcraft register

Upload your charm and any subsequent revisions to Charmhub with:

charmcraft upload

Installation

Charmcraft is available on all major Linux distributions and macOS.

The recommended way to install Charmcraft on Linux systems is through its snap.

sudo snap install charmcraft --classic

For information on installing Charmcraft on other platforms, refer to our installation guide.

Documentation

The Charmcraft documentation provides guidance and learning materials for every step of the charming process. Whether you're new to charming or a seasoned expert, this is the best place to deepen your knowledge.

Community and support

To get in touch with developers and other charmcraft-badge: https://snapcraft.io/charmcraft/badge.svg charmcraft-site: https://snapcraft.io/charmcraft members of the charming community, reach out on the forum or in our Matrix channel.

You can report any issues or bugs on the project's GitHub repository.

Charmcraft is covered by the Ubuntu Code of Conduct.

Contribute to Charmcraft

Charmcraft is open source and part of the Canonical family. We would love your help.

If you're interested, start with the contribution guide.

We welcome any suggestions and help with the docs. The Canonical Open Documentation Academy is the hub for doc development, including Charmcraft docs. No prior coding experience is required.

License and copyright

Charmcraft is released under the Apache-2.0 license

© 2023-2025 Canonical Ltd.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

charmcraft-3.5.2.tar.gz (715.9 kB view details)

Uploaded Source

Built Distribution

charmcraft-3.5.2-py3-none-any.whl (233.3 kB view details)

Uploaded Python 3

File details

Details for the file charmcraft-3.5.2.tar.gz.

File metadata

  • Download URL: charmcraft-3.5.2.tar.gz
  • Upload date:
  • Size: 715.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for charmcraft-3.5.2.tar.gz
Algorithm Hash digest
SHA256 1dc8c3a2eee26d1f90ccb4cd2fd200f499d33f04eef74e8caff043ae1ba8aebf
MD5 4d0fc76816b52027342ab809cbbfcdfd
BLAKE2b-256 1a976fc876012cb040f782b0eb3ac8b118f349272e98dd2c5abd09076b08f299

See more details on using hashes here.

Provenance

The following attestation bundles were made for charmcraft-3.5.2.tar.gz:

Publisher: release-publish.yaml on canonical/charmcraft

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file charmcraft-3.5.2-py3-none-any.whl.

File metadata

  • Download URL: charmcraft-3.5.2-py3-none-any.whl
  • Upload date:
  • Size: 233.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for charmcraft-3.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3cca85db2c7f5ac135d2a20bc39588fed4a6a08980be71a0a8458fa947369cbf
MD5 c2dc971965a9f351fe9ef27657f1dfd8
BLAKE2b-256 fdbd48915805e142e8e334be573bd7c8045e28ab0501f42a0d57d6627d0300aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for charmcraft-3.5.2-py3-none-any.whl:

Publisher: release-publish.yaml on canonical/charmcraft

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page