Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2 KB

README.md

File metadata and controls

57 lines (40 loc) · 2 KB
Raw

mite-cli

A CLI interface for time-tracking in Mite. Currently only adding and editing entries and listing entries, projects and services is supported.

Installation

You can install mite through pip:

pip install mite-cli

Usage

There are six subcommands, init, add, edit, entries, projects, and services.

init adds your profile configuration, so you don’t have to enter it every time. Call it once after installing mite like so:

mite init --team <your mite team name, e.g. portzero> --api-key <your api key>

Learn how to obtain a personalized API key here.

After setting mite up, you can then use the add and edit commands.

If you call mite add without any arguments, it will do the following:

  • Assume that you want to add an entry for today (change by providing the --date argument)
  • Assume that you want to add an entry for 480 minutes, i.e. 8 hours (change by providing the --minutes argument)
  • Open your favorite editor as determined by the EDITOR system variable so you can type in a note (you can also skip this if you provide a --note argument)
  • Fetch all of your active projects and lets you choose from them (skip this by providing a --project-id argument)
  • Fetch all of your active service and lets you choose from them (skip this by providing a --service-id argument)
  • Tell mite to add that entry and, if you chose a project or service interactively, show you those IDs so you can add them via arguments next time.

If you forget those IDs again, simply type mite projects or mite services to fetch and display a list of projects and services and their IDs.

If you want to edit an entry, call mite edit. It accepts the same arguments as adding, plus an ID. If you don’t have an entry ID handy, you can either search for it using mite entries or go select it interactively in the command (beware that the list of entries might be a little long).

And that’s it!

Have fun!