Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/almonk/ogpk
a cli tool for observing og data
https://github.com/almonk/ogpk
Last synced: about 2 months ago
JSON representation
a cli tool for observing og data
- Host: GitHub
- URL: https://github.com/almonk/ogpk
- Owner: almonk
- License: mit
- Created: 2023-10-07T13:46:29.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-18T10:57:21.000Z (about 1 year ago)
- Last Synced: 2024-04-15T15:32:00.398Z (9 months ago)
- Language: Go
- Homepage: https://alasdairmonk.com
- Size: 854 KB
- Stars: 107
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# ogpk (opengraph peek)
`ogpk` is a simple CLI tool written in Go that fetches OpenGraph data from a given URL. If the optional dependency `timg` is installed, `ogpk` can also display the `og:image` directly in the terminal.
### Installation
On macOS:
```bash
brew tap almonk/ogpk
brew install ogpk
```
On linux:
* Go to the [releases page](https://github.com/almonk/ogpk/releases) and download the latest release for your platform.
* Extract the archive and move the executable to a directory in your `PATH` (e.g. `/usr/local/bin`)
* Make the executable executable, e.g.:
```bash
chmod +x /usr/local/bin/ogpk
```
### Usage
To fetch OpenGraph data from a website:
```bash
ogpk [URL]
```
For example:
```bash
ogpk https://example.com
```
To display the `og:image` in the terminal (requires `timg`):
```bash
ogpk [URL] --p
```
Output data as JSON:
```bash
ogpk [URL] --json
```
### Building from source
Clone this repository:
```bash
git clone https://github.com/almonk/ogpk.git
```
Navigate to the cloned directory:
```bash
cd ogpk
```
Build the tool:
```bash
go build -o ogpk
```
This will produce an executable named `ogpk` in the current directory.
### Optional Dependency on `timg`
ogpk has an optional dependency on `timg`, a terminal image viewer. If `timg` is installed and available in the `PATH`, ogpk can display the `og:image` directly in the terminal when the `--p` flag is used.
To install `timg`, refer to its [official documentation](https://github.com/hzeller/timg).