Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/madh93/toffu

⏳ Woffu presence from your terminal
https://github.com/madh93/toffu

cli go golang presence woffu

Last synced: 21 days ago
JSON representation

⏳ Woffu presence from your terminal

Host: GitHub
URL: https://github.com/madh93/toffu
Owner: Madh93
License: mit
Created: 2023-07-13T00:10:15.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-07-15T15:32:40.000Z (5 months ago)
Last Synced: 2024-07-15T18:54:59.892Z (5 months ago)
Topics: cli, go, golang, presence, woffu
Language: Go
Homepage:
Size: 1.51 MB
Stars: 1
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Toffu

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)

Toffu is a command-line interface (CLI) tool that enables users to manage their work schedule presence in [Woffu](https://www.woffu.com) directly from the terminal. With Toffu, users can conveniently interact with their Woffu account without the need to access the Woffu web interface.

Toffu Demo

Installation •
Usage •
Examples •
Useful Links •
License

## Installation

### GNU/Linux or macOS

Via [Homebrew](https://brew.sh/):

```shell
brew install madh93/tap/toffu
```

### Windows

Via [Scoop](https://scoop.sh/):

```shell
scoop bucket add madh93 https://github.com/madh93/scoop-bucket.git
scoop install toffu
```

### From releases

Stable binaries for all platforms are available on the [releases page](https://github.com/Madh93/toffu/releases). To install, download the binary for your platform from "Assets", extract the downloaded file and place `toffu` into your `PATH`:

```shell
curl -L https://github.com/Madh93/toffu/releases/latest/download/toffu_$(uname -s)_$(uname -m).tar.gz | tar -xz -O toffu > /usr/local/bin/toffu
chmod +x /usr/local/bin/toffu
```

### Go

If you have Go installed:

```shell
go install github.com/Madh93/toffu@latest
```

### From source

Install Go if it is not already installed. You can download it from the official [website](https://golang.org/dl).

Clone the `toffu` repository to build and install the binary:

```shell
git clone https://github.com/Madh93/toffu && cd toffu && make install
```

## Usage

```shell
Toffu is a simple CLI to manage presence in Woffu from your terminal

Usage:
toffu [flags]
toffu [command]

Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
in On-demand clock-in
out On-demand clock-out
status Show current status
token Generate API token (Required the first time)

Flags:
-c, --config string config file for toffu
-d, --debug enable debug mode
-h, --help help for toffu
-v, --version version for toffu

Use "toffu [command] --help" for more information about a command.
```

### Generate a token

Before using Toffu, an API token needs to be generated for authentication. Keep in mind that the token expires after three months. After this time, you will need to generate a new token:

Clock in