Skip to content

canonical/imagecraft

Repository files navigation

Imagecraft

Imagecraft Tests Documentation Status Codecov Status Code Style

Imagecraft is a craft tool used to create Ubuntu bootable images. It follows the same principles as Snapcraft, but is focused on creating bootable images instead.

Documentation

Imagecraft documentation is built from reStructuredText (.rst) files, most of them under the docs/ folder in the source tree. Build and browse the documentation locally if you prefer, although the product website is recommended.

Build and browse the documentation locally

Clone the official source tree from GitHub into your computer's home directory. Its default location will then be ~/imagecraft/. (You may clone the Imagecraft repository directly. However, it's protected: if you plan on contributing to the project, consider forking it to your own GitHub account then cloning that instead.)

Install the documentation tools:

make setup-docs

Build and serve the documentation:

make docs-auto

Point your web browser to address 127.0.0.1:8080.

Community and support

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

Imagecraft is covered by the Ubuntu Code of Conduct.

Contribute to Imagecraft

Imagecraft 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 Imagecraft docs. No prior coding experience is required.

License and copyright

Imagecraft is released under the GPL-3.0 license.

© 2023-2025 Canonical Ltd.

About

Customize and build bootable Ubuntu images.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 15