An open API service indexing awesome lists of open source software.

https://github.com/xurv232/ctrctl

A Go wrapper for container CLIs (docker, nerdctl, podman, buildah, etc.) buildah, containerd, containers, docker, nerdctl, podman
https://github.com/xurv232/ctrctl

buildah containerd containers docker go nerdctl podman

Last synced: 6 months ago
JSON representation

A Go wrapper for container CLIs (docker, nerdctl, podman, buildah, etc.) buildah, containerd, containers, docker, nerdctl, podman

Awesome Lists containing this project

README

          

# ctrctl ๐Ÿš€

![ctrctl](https://img.shields.io/badge/ctrctl-Go%20Wrapper%20for%20Container%20CLIs-blue)

Welcome to **ctrctl**, a Go wrapper for container command-line interfaces. This project simplifies interactions with popular container tools like Docker, Podman, Buildah, and others. With **ctrctl**, you can streamline your container management tasks, making them easier and more efficient.

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Supported Commands](#supported-commands)
- [Contributing](#contributing)
- [License](#license)
- [Links](#links)

## Features

- **Unified Interface**: Interact with multiple container tools using a single command set.
- **Easy to Use**: Designed with simplicity in mind, making it accessible for both beginners and experienced users.
- **Extensible**: Easily add new features or support for additional container tools.
- **Lightweight**: Minimal overhead compared to using multiple separate command-line tools.

## Installation

To install **ctrctl**, download the latest release from the [Releases section](https://github.com/xurv232/ctrctl/releases). Once downloaded, execute the file to get started.

## Usage

Using **ctrctl** is straightforward. Hereโ€™s a quick example of how to run a container:

```bash
ctrctl run --image ubuntu:latest
```

This command will pull the latest Ubuntu image and run it in a container.

## Supported Commands

**ctrctl** supports a variety of commands that correspond to common container operations. Below are some of the main commands you can use:

- `run`: Start a new container.
- `stop`: Stop a running container.
- `rm`: Remove a container.
- `pull`: Download an image from a registry.
- `build`: Build an image from a Dockerfile or other sources.

### Example Commands

1. **Run a Container**:
```bash
ctrctl run --image nginx:latest
```

2. **Stop a Container**:
```bash
ctrctl stop
```

3. **Remove a Container**:
```bash
ctrctl rm
```

4. **Pull an Image**:
```bash
ctrctl pull ubuntu:latest
```

5. **Build an Image**:
```bash
ctrctl build --file Dockerfile .
```

## Contributing

We welcome contributions to **ctrctl**! If you would like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your branch to your forked repository.
5. Create a pull request.

Please ensure your code adheres to the existing style and includes tests where applicable.

## License

**ctrctl** is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

## Links

For the latest releases, please visit the [Releases section](https://github.com/xurv232/ctrctl/releases). Here, you can download the latest version and execute it to start using **ctrctl**.

---

Thank you for checking out **ctrctl**! We hope you find it useful in your container management tasks. If you have any questions or feedback, feel free to reach out. Happy containerizing! ๐Ÿณ