This is very early in development, and is not ready for use yet.

Anything can change, directory paths, file names, repo name, behavior, etc.

README is old

devcontainer-use

devcontainer-use is a tool that helps you create and use development environments inside Docker containers. It utilizes the devcontainer.json file format with devcontainer-cli to build and run the Docker containers.

It simiplifies the process of managing and creating DevContainers by using profiles such as the default nvim profile which let's you create a NeoVim development environment inside a Docker container with a single command.

Usage

By default devcontainer-use will come with a default nvim profile. To use it, run the following command in your terminal:

devcontainer-use nvim

or

devcontainer-use nvim ./path/to/project

This will build and run a Docker container with a NeoVim development environment.

The container will be stopped automatically when you exit from the container's shell unless there is no other terminals attached to the container.

Custom Profiles

Default nvim profile will be inside ~/.config/devcontainer-use/profiles/nvim.json. You can create your own profiles by creating new JSON files inside ~/.config/devcontainer-use/profiles/.

Default Nvim Profile

Default nvim profile will install nvim, lazyvim and lazygit inside the container.

The NeoVim configuration inside the container will be stored in a separate directory on your host machine to avoid conflicts with your local NeoVim setup. By default, the configuration will be located at:

Host:

~/.config/devcontainer-use/nvim/config

Container:

~/.config/nvim

Installation

Requirements:

• docker
• jq
• devcontainer-cli

To install devcontainer-use, run the following commands in your terminal:

git clone https://github.com/DeepDoge/devcontainer-use.git /tmp/devcontainer-use && \
mv /tmp/devcontainer-use/devcontainer-use ~/.local/bin && \
chmod +x ~/.local/bin/devcontainer-use && \
rm -rf /tmp/devcontainer-use

Uninstallation

To uninstall devcontainer-use, run the following command in your terminal:

rm ~/.local/bin/devcontainer-use
rm -rf ~/.config/devcontainer-use

Contribution

Contributions to devcontainer-use are welcome! If you encounter any issues or have suggestions for improvements, feel free to submit an issue or a pull request on the GitHub repository.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Happy coding with devcontainer-use! 🚀

- Writen by ChatGPT