https://github.com/powersj/imgchroot

Quickly interact and customize a cloud image
https://github.com/powersj/imgchroot

chroot cli cloud-image disk-image go golang

Last synced: 22 days ago
JSON representation

Quickly interact and customize a cloud image

• Host: GitHub
• URL: https://github.com/powersj/imgchroot
• Owner: powersj
• License: gpl-3.0
• Created: 2021-01-30T18:34:30.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-06-17T20:05:28.000Z (almost 2 years ago)
• Last Synced: 2024-11-01T09:34:57.654Z (6 months ago)
• Topics: chroot, cli, cloud-image, disk-image, go, golang
• Language: Go
• Homepage: https://powersj.github.io/imgchroot
• Size: 587 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# imgchroot

*Quickly interact and customize a cloud image*

[![Build Status](https://travis-ci.com/powersj/imgchroot.svg?branch=master)](https://travis-ci.com/powersj/imgchroot/) [![Go Report Card](https://goreportcard.com/badge/github.com/powersj/imgchroot)](https://goreportcard.com/report/github.com/powersj/imgchroot) [![Go Reference](https://pkg.go.dev/badge/github.com/powersj/imgchroot.svg)](https://pkg.go.dev/github.com/powersj/imgchroot)

## Overview

imgchroot is a Go-based CLI to quickly customize cloud images in a chroot

without the need to boot the image or setup a user with credentials.

imgchroot mounts the image to a temporary directory, using the network

block device (NBD) protocol. It then runs the required operation, such as a

command, moving a file, or starts a shell in the chroot. Once the operation is

complete the image is unmounted all without needing to boot the image itself.

## CLI

Here are the primary functions available via the CLI:

1. **Chroot** commands will run commands against the image inside a chroot.

   This includes command execution, via a shell, or push and pull files from

   the image.

1. **Download** latest cloud images

### Chroot

imgchroot provides a number of different sub-commands to directly interact

with a cloud image. Click to see the sub-command's CLI page for more details:

* [exec](https://powersj.github.io/imgchroot/chroot/#exec): run a command on

  the image

* [info](https://powersj.github.io/imgchroot/chroot/#info): information about

  the image

* [pull](https://powersj.github.io/imgchroot/chroot/#pull): pull a file from

  the image

* [push](https://powersj.github.io/imgchroot/chroot/#push): push a file to the

  image

* [run](https://powersj.github.io/imgchroot/chroot/#run): transfer and run a

  file on the image

* [shell](https://powersj.github.io/imgchroot/chroot/#shell): start a shell on

  the image

### Download

imgchroot has the ability to find the latest cloud images as well. A user

needs to provide the distro (e.g. ubuntu) and release (e.g. focal) to download.

The the download will find the URL and download it.

See the [download](https://powersj.github.io/imgchroot/download) sub-command

for more information.

## Support

If you find a bug, have a question, or ideas for improvements please file an

[issue](https://github.com/powersj/imgchroot/issues/new) on GitHub.