https://github.com/zpratt/jig

Tired of making sure that everyone has the correct tools installed on their machine
https://github.com/zpratt/jig

developer-experience developer-tools go golang hacktoberfest package-management

Last synced: 16 days ago
JSON representation

Tired of making sure that everyone has the correct tools installed on their machine

• Host: GitHub
• URL: https://github.com/zpratt/jig
• Owner: zpratt
• License: mit
• Created: 2020-11-25T01:27:14.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-11-01T14:16:54.000Z (over 3 years ago)
• Last Synced: 2025-02-13T11:37:02.282Z (2 months ago)
• Topics: developer-experience, developer-tools, go, golang, hacktoberfest, package-management
• Language: Go
• Homepage:
• Size: 37.1 KB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jig

[![Go](https://github.com/zpratt/jig/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/zpratt/jig/actions/workflows/go.yml)

[![DeepSource](https://deepsource.io/gh/zpratt/jig.svg/?label=active+issues&show_trend=true&token=JVh0vjfvtlSU8toDhk8quj9O)](https://deepsource.io/gh/zpratt/jig/?ref=repository-badge)

Tired of making sure that everyone has the correct tools installed on their machine regardless of OS? `jig` will read the jig.yaml file and check your `$PATH` environment variable for installed tools. 

## How To Use

Note: Currently, there are no releases, so you have to build this from scratch.

1. clone the repo

1. make sure you have at least go 1.14 installed

1. `make build`

1. `./jig`

You can update the jig.yaml file to include a list of tools that you expect to be installed.

## Roadmap

* [x] - check the `$PATH` for installed tools. Print a list of required programs that are not installed.

* [ ] - for programs that are not installed, attempt to install them using a package manager (ex: apt, brew, choco, scoop).

* [ ] - better document the schema of the jig file.

* [ ] - support transforming `brew list -1` to a jig file (`--import` switch?)

* [ ] - allow for project specific jig files instead of looking for one in the current directory

* [ ] - check for required configuration files (which could be expressed in the jig.yaml file)

* [ ] - add a dry run option

* [ ] - check the version of tools and see if an update is available.

* [ ] - allow for OS equivalent packages to be expressed in the jig file

  * ex: `pbcopy` come pre-installed on a mac. on windows, they require a separate package. chocolately has a pasteboard package for this. 

## Contributing

Not sure yet. I need to add tests and a roadmap of some kind. Feel free to submit issues if you have ideas.