goconfig

A tool for managing, merging, and applying configuration files.
README · CONTRIBUTING · CHANGELOG
Report Bug · Request Feature

Table of contents

• About the project
  • Built with
• Getting started
  • Installation
• Usage
• Roadmap
• Local development
  • Prerequisites
  • Taskfile targets
• Contributing
• License
• Contact

About the project

Built with

• Golang 1.16

Getting started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repository

   git clone https://github.com/davidalpert/goconfig.git

Usage

Run the goconfig binary with no arguments to show command-line help.

Roadmap

See the open issues for a list of proposed features and known issues.

Local development

Prerequisites

goconfig builds and ships as a single-file binary with no prerequisites to make installation and updates easy.

• golang
  • with a working go installation:

    go install golang.org/dl/go1.16@latest
    go1.16 download
    

• this repository includes a ./.tools/doctor.sh script which validates your local environment and installs or helps you install missing dependencies
• Taskfile a task runner

Taskfile targets

This repository includes a Taskfile for help running common tasks.

Run task with no arguments to list the available targets:

$ task
goconfig v0.0.0

task: Available tasks for this project:
* autotest:       run tests continuously using goconvey's test UI
* build:          build
* gen:            run code-generation
* help:           list targets
* test:           run tests

Contributing

See the CONTRIBUTING guide for local development setup and contribution guidelines.

1. Fork the Project
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 GPU v3 License. See LICENSE for more information.

Contact

David Alpert - @davidalpert

Project Link: https://github.com/davidalpert/goconfig