Giter Club home page Giter Club logo

worklog's Introduction

Worklog

Worklog is a simple multiplatform CLI application to log what you are currently working on. It is written with Kotlin Native, and utilizes the awesome clikt library.

Features

It currently supports:

  • Adding log items
  • Listing log items
    • Listing with, or without timestamps
    • Depending on the terminal, printing either uses colors, or is simplified
  • Use a custom configuration file

Known issues

  • The application currently can not support UTF-8 charset in Windows, so characters like áéíóöőúüű will not be displayed correctly. This is a limitation of the Kotlin Native platform and not the application itself.

Usage

Adding log items: add

Listing log items: list

For more information, use the --help flag.

Installation

Simply download from the Releases section, and run without any installation. The extension of the macOS binary can be misleading, but do not be alarmed by the .kexe extension. You can run it as it is, or rename the executable as you wish.

Configuration

The application saves the log items by default to ~/.worklog. You can change this by creating a configuration file ~/.worklogrc. The configuration file can contain the following:

Key Description Default
showTimestamps Whether to show timestamps in the list command false
dataFile The file to save the log items to ~/.worklog

Example configuration file:

{
  "showTimestamps": false,
  "dataFile": "/path/to/your/file"
}

worklog's People

Contributors

tothlp avatar

Watchers

 avatar

worklog's Issues

Make list more readable

like a markdown format, categorized by date, with bullets.

maybe for full list, include a table?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.