This project provides a CLI tool to apply devcontainer templates to your workspace.
To install the CLI tool using go get, run the following command:
go get github.com/mazurov/devcontainer-templateThis will download and install the devctmpl binary to your $GOPATH/bin directory.
To install the CLI tool, you can build it from source:
git clone https://github.com/mazurov/devcontainer-template.git
cd devcontainer-template
make buildThis will create the devctmpl binary in the bin/ directory.
To use the CLI tool, run the following command:
devctmpl -w /path/to/workspace -t template-id --template-args '{"key": "value"}' --log-level info-w, --workspace-folder: Target workspace folder (required)-t, --template-id: Source template directory (OCI repo, archive) (required)-a, --template-args: Template arguments as JSON string--tmp-dir: Directory to use for temporary files. If not provided, the system default will be used.--keep-tmp-dir: Keep temporary directory after execution--omit-paths: List of paths within the Template to omit applying, provided as JSON. To ignore a directory append '/*'-l, --log-level: Log level (debug, info, warn, error)
To contribute to the project, follow these steps:
- Fork the repository
- Create a new branch (
git checkout -b feature-branch) - Make your changes
- Commit your changes (
git commit -am 'Add new feature') - Push to the branch (
git push origin feature-branch) - Create a new Pull Request
To run the tests, use the following command:
make testThis project is licensed under the MIT License. See the LICENSE file for details.
This README.md provides an overview of the project, installation instructions, usage examples, development guidelines, testing instructions, and contribution guidelines. Adjust the content as needed to fit your project's specifics.