tk

A CLI tool that bootstraps your projects with pre-configured Taskfile powerpacks. Stop copying boilerplate configs between projects—install what you need in seconds.

Table of Content

• Features
• Prerequisites
• Installation
  • Binaries via GitHub Releases
  • Binary Installation using Script
  • Docker Image
• Usage
• Development
  • Repository Structure
  • Development with Taskfile
• Contributing
• License

Features

• Powerpacks: Curated bundles of Taskfile configurations for common tools (linters, formatters, CI workflows)
• Zero config: Sensible defaults that work out of the box
• Composable: Mix and match powerpacks to fit your stack
• Consistent: Same tooling setup across all your projects

Prerequisites

To make the most out of this project, ensure the following tools are installed:

• Git: Essential for version control and managing codebase changes.
• Task: A task runner facilitating automated workflows and tasks (v3.38.0 or later).
• jq: A lightweight and flexible command-line JSON processor (v1.7.1 or later).

Installation

Binaries via GitHub Releases

1. Visit the GitHub Releases page of this repository.
2. Download the appropriate binary for your operating system.
3. Make the downloaded file executable:

   chmod +x tk

4. Move it to a location within your PATH, such as /usr/local/bin, for easy access.

Binary Installation using Script

1. Install tk using the installation script:

   # binary will be installed in $(go env GOPATH)/bin/tk
   curl -sSfL https://raw.githubusercontent.com/merlindorin/tk/master/install.sh | sh -s -- -b $(go env GOPATH)/bin latest
   tk --version

2. Note for Windows users: You can run the above commands with Git Bash, which comes with Git for Windows.

Docker Image

1. Pull the Docker image directly from the GitHub repository:

   docker pull ghcr.io/merlindorin/tk:latest

2. Run the tk CLI using Docker:

   docker run ghcr.io/merlindorin/tk:latest [command]

Usage

Use the tk CLI to install powerpacks, which include Taskfiles. These files are tailored for efficient management of tools and environments, easing development workflows.

Development

To develop and test features for the tk CLI:

1. Clone this repository:

   git clone https://github.com/merlindorin/tk.git
   cd tk

2. Install necessary dependencies and tools.

3. Use a feature branch for your development:

   git checkout -b feature/my-new-feature

4. Develop and test your changes locally.

5. Commit your changes with descriptive messages.

Development with Taskfile

Leverage the Taskfile in this repository to automate common development tasks. Typical tasks available include building the CLI, running tests, and linting the codebase. Review the Taskfile.yaml available in the root directory to understand the tasks and their configuration.

Contributing

Interested in contributing?

• Fork the repository.
• Create a branch for your feature: git checkout -b feature/your-feature.
• Commit your changes: git commit -am 'Add a feature'.
• Push to your branch: git push origin feature/your-feature.
• Open a pull request for review.

License

Licensed under the MIT License. See LICENSE.md for further information.