Skip to content

Latest commit

 

History

History
159 lines (108 loc) · 4.08 KB

README.md

File metadata and controls

159 lines (108 loc) · 4.08 KB

dockerbx

dockerbx is a Docker-based alternative to toolbx, designed for macOS users who want to create and manage isolated development environments easily. It provides a simple CLI interface to create, enter, and manage containers, allowing developers to maintain separate environments for different projects without cluttering their main system.

Features

  • Create isolated development environments using Docker containers
  • Enter containers with a simple command, starting them if they're not running
  • List all dockerbx containers
  • Remove containers easily, with options for force removal and bulk operations
  • Seamless integration with the host file system
  • Based on Fedora images for a familiar Linux environment
  • Python environment setup with custom versions and package management
  • Direct repository cloning into containers
  • Configuration import/export for easy sharing and replication

Installation

To install dockerbx, you can just download the binary from the release page, or build the latest development version by yourself (you need to have Go and Docker installed on your macOS system).

  1. Clone the repository:

    git clone https://github.com/albertoperdomo2/dockerbx.git

  2. Navigate to the project directory:

    cd dockerbx

  3. Build the project:

    go build -o dockerbx cmd/dockerbx/main.go

  4. Move the binary to a directory in your PATH:

    sudo mv dockerbx /usr/local/bin/

Usage

Initialize dockerbx

Before using dockerbx, run the init command:

dockerbx init

This will set up the necessary Docker images and configurations.

Create a new container

dockerbx create [container_name] [--clone <repository_url>]

If no name is provided, it will use the default name from the config file. Use the --clone flag to clone a Git repository into the container.

Create a Python environment

dockerbx python [container_name] --version <python_version> --venv <venv_name> --packages <package1> <package2> --requirements <path_to_requirements.txt>

Creates a Python-specific container with the specified version, virtual environment, and packages.

Enter a container

dockerbx enter [container_name]

This will start the container if it's not running and give you an interactive shell.

List containers

dockerbx list

Shows all dockerbx containers, their status, and creation date.

Remove containers

dockerbx rm [container_name...]

Remove one or more containers. Use flags for additional options:

  • -f or --force: Force removal of running containers
  • -a or --all: Remove all dockerbx containers

Run a command in a container

dockerbx run [container_name] [command]

Executes a command in the specified container without entering it.

Update a container

dockerbx update [container_name]

Updates the container's base image and optionally updates packages within the container. Use the -p or --packages flag to update packages.

Export configuration

dockerbx export-config [file_name]

Exports the current configuration to a YAML file.

Import configuration

dockerbx import-config <file_name>

Imports a configuration from a YAML file.

Configuration

The configuration file is located at ~/.config/dockerbx/dockerbx.yaml. You can modify this file to change default settings. Here's an example configuration:

base_image: "ubuntu:20.04"
default_name: "dockerbx-default"
mounts:
  - type: "bind"
    source: "/home/user/projects"
    target: "/projects"
    read_only: false

Development

To contribute to dockerbx:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements