Skip to content

A simple and well-polished cli application used to keep track of your day to day productivity.

License

Notifications You must be signed in to change notification settings

anesthetice/Syracuse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Syracuse

Syracuse is a simple and well-polished cli application used to keep track of your day to day productivity.

It operates through an entry system, allowing you to start timers, check in and out, unindex old entries, generate graphs, etc. Everything is designed to be as effortless as possible, need a quick overview of your day? Just run syracuse today; want to break-down each entry's contribution as well? Simple, just set the flag for it syracuse today -e.

Example

syracuse graph --days 14

linear interpolation

makima interpolation

Build

git clone https://github.com/anesthetice/Syracuse.git
cd Syracuse
cargo build --release

Installation

  • Follow the build instructions or download a pre-compiled binary
  • If you are running windows, place the binary wherever works for you and add the folder to your PATH
  • If you are running linux, place the binary wherever works for you and create a utility function to run it

example for bash:

# .bashrc (at the end of the file)
function syr {
    $HOME/Documents/Syracuse/syracuse-x86_64-unkown-linux-gnu $@
}

example for fish:

# .config/fish/functions/syr.fish
function syr
    $HOME/Documents/Syracuse/syracuse-x86_64-unkown-linux-gnu $argv
end

Usage

Usage: syracuse [COMMAND]

Commands:
  add         Add a new entry to syracuse
  list        List out stored entries
  remove      Remove an entry
  start       Start the daily stopwatch for an entry
  update-add  Manually increase the time tracked by an entry
  update-sub  Manually decrease the time tracked by an entry
  today       Display the time tracked today
  backup      Create a backup of all entries
  unindex     Unindex one or more entries
  reindex     Reindex one or more entries
  sum         Sum up the time tracked by entries
  prune       Discard all blocs that are less recent than the cutoff date
  graph       Graph the time tracked by entries in a given timeframe
  check-in    Check-in an entry
  check-out   Check-out an entry
  week        Display the time tracked this week
  help        Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Configuring

When running Syracuse for the first time, a default config file will be created. See config.rs for more info.

Version 2

  • Modular entries
  • Improved reliability and stability (no unsafe code)
  • Smith-Waterman and Needleman-Wunsch algorithms entry queries
  • Revamped graphs with interpolation
  • More graphing options
  • Better directory usage
  • New subcommands, "today", "backup", "prune"

Version 3

  • Code clean-up
  • Improved visuals
  • New subcommands, "check-in", "check-out", "sum", "index", "unindex"
  • More that I am probably forgetting

About

A simple and well-polished cli application used to keep track of your day to day productivity.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published