Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/haya14busa/cachecmd

cache command!
https://github.com/haya14busa/cachecmd

cache cli

Last synced: about 3 hours ago
JSON representation

cache command!

Awesome Lists containing this project

README

        

# cachecmd

[![Build Status](https://travis-ci.org/haya14busa/cachecmd.svg?branch=master)](https://travis-ci.org/haya14busa/cachecmd)
[![codecov](https://codecov.io/gh/haya14busa/cachecmd/branch/master/graph/badge.svg)](https://codecov.io/gh/haya14busa/cachecmd)
[![Go Report Card](https://goreportcard.com/badge/github.com/haya14busa/cachecmd)](https://goreportcard.com/report/github.com/haya14busa/cachecmd)
[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

cachecmd runs a given command and caches the result of the command.
Return cached result instead if cache found.

## Installation

```shell
go install github.com/haya14busa/cachecmd/cmd/cachecmd@latest
```

## Example

```shell
$ cachecmd -ttl=10s date +%S
14 # First run
$ sleep 5s
$ cachecmd -ttl=10s date +%S
14 # Read from cache
$ sleep 5s
$ cachecmd -ttl=10s date +%S
24 # cache is expired. Run command again and update cache.

# Force update: set -ttl=0
$ cachecmd -ttl=0 date +%S

# TTL is 10 min. Return cache result immediately from cache and update cache
# in background for every run.
$ cachecmd -ttl=10m -async sh -c 'date +%s; sleep 3s'

# Cache result by current directory.
$ cachecmd -ttl=10m -key="$(pwd)" go list ./...
# https://github.com/github/hub
$ cachecmd -ttl=10m -key="$(pwd)" -async hub issue
```

## :bird: Author
haya14busa (https://github.com/haya14busa)