https://github.com/konoui/alfred-tldr

tldr with alfred workflow written in Go
https://github.com/konoui/alfred-tldr

alfred alfred-tldr alfred-workflow go golang tldr tldr-alfred tldr-pages

Last synced: 3 months ago
JSON representation

tldr with alfred workflow written in Go

• Host: GitHub
• URL: https://github.com/konoui/alfred-tldr
• Owner: konoui
• License: mit
• Created: 2019-08-13T11:45:13.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-10-23T03:13:11.000Z (over 1 year ago)
• Last Synced: 2024-10-23T20:11:15.489Z (4 months ago)
• Topics: alfred, alfred-tldr, alfred-workflow, go, golang, tldr, tldr-alfred, tldr-pages
• Language: Go
• Homepage:
• Size: 1.53 MB
• Stars: 101
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Generic badge](https://github.com/konoui/alfred-tldr/workflows/test_release/badge.svg)

## alfred tldr

[tldr-pages](https://github.com/tldr-pages/tldr) alfred workflow written in go.

![alfred-tldr](./alfred-tldr.gif)

## Usage

`tldr `

Options  

`--version`/`-v` option shows the current version of the client.  

`--update`/`-u` option updates local database (tldr repository).  

`--platform`/`-p` option selects platform from `linux`,`osx`,`sunos`,`windows`.  

`--language`/`-L` option selects preferred language for the page.

## Install

- Download and open the workflow with terminal for macOS.

```

$ curl -O -L https://github.com/konoui/alfred-tldr/releases/latest/download/tldr.alfredworkflow && open tldr.alfredworkflow

```

- Build the workflow on your computer.

```

$ make package

$ ls

tldr.alfredworkflow (snip)

```

## Configurations

Please see [here](./doc/CONFIGURATION.md)

## License

MIT License.

## Special Thanks

Icons are provided by [takafumi-max](https://github.com/takafumi-max)