mite-cli

Easy to use CLI tool for creating, listing, starting and stopping time tracking entries in [Mite](https://mite.de) and much other things using the [mite-api](https://www.npmjs.com/package/mite-api) npm package which is using the [official mite api](https://mite.de/api/index.html). [![MIT License](https://badges.frapsoft.com/os/mit/mit.svg?v=102)](https://github.com/ellerbrock/open-source-badge/) [![NPM Package](https://badge.fury.io/js/mite-cli.svg)](https://www.npmjs.com/package/mite-cli) [![NPM Downloads](https://img.shields.io/npm/dt/mite-cli.svg)](https://www.npmjs.com/package/mite-cli) [![Known Vulnerabilities](https://snyk.io/test/github/ephigenia/mite-cli/badge.svg)](https://snyk.io/test/github/ephigenia/mite-cli) [![Maintainability](https://api.codeclimate.com/v1/badges/791e0126615bcd34a0e5/maintainability)](https://codeclimate.com/github/Ephigenia/mite-cli/maintainability) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FEphigenia%2Fmite-cli.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FEphigenia%2Fmite-cli?ref=badge_shield) [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Ephigenia/mite-cli.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Ephigenia/mite-cli/context:javascript) [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Ephigenia/mite-cli.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Ephigenia/mite-cli/context:javascript) [![Rate on Openbase](https://badges.openbase.com/js/rating/mite-cli.svg)](https://openbase.com/js/mite-cli?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge) - [Features](#features) - [Installation](#installation) - [Global](#global) - [Local](#local) - [via NPX](#via-npx) - [Configuration](#configuration) - [Configuration Options](#configuration-options) - [Defaults](#defaults) - [Auto-Completion](#auto-completion) - [Usage](#usage) - [Time Entries](#time-entries) - [List](#list) - [Filter by time](#filter-by-time) - [Other Filters](#other-filters) - [Grouping / Reports](#grouping--reports) - [Advanced Examples](#advanced-examples) - [Disabling Unicode Characters](#disabling-unicode-characters) - [Create Time-Entries](#create-time-entries) - [Interactive](#interactive) - [Non-Interactive](#non-interactive) - [Shortcuts](#shortcuts) - [Advanced Usage](#advanced-usage) - [Start & Open Entry](#start--open-entry) - [Tracker](#tracker) - [Start Tracking](#start-tracking) - [Resume Tracking](#resume-tracking) - [Stop Tracking](#stop-tracking) - [Modify Time-Entries](#modify-time-entries) - [Change Note](#change-note) - [Change Service or Project](#change-service-or-project) - [Set Tracked Time](#set-tracked-time) - [Adding/Removing Time](#addingremoving-time) - [Move Time Entry to another date](#move-time-entry-to-another-date) - [Un-/Lock Entry](#un-lock-entry) - [Delete entry](#delete-entry) - [Open](#open) - [Users](#users) - [Customers](#customers) - [Create Customer](#create-customer) - [Update Customer](#update-customer) - [Delete Customer](#delete-customer) - [Projects](#projects) - [Create Project](#create-project) - [Update Project](#update-project) - [Delete Project](#delete-project) - [Services](#services) - [Update Service](#update-service) - [Delete Service](#delete-service) - [Advanced Topics](#advanced-topics) - [Cache](#cache) - [Columns](#columns) - [Plotting Charts](#plotting-charts) - [Alternate Output formats](#alternate-output-formats) - [Exporting CSVs](#exporting-csvs) - [Batch-Edit Time Entries](#batch-edit-time-entries) - [Monthly/Daily summary](#monthlydaily-summary) - [Generating PDFs](#generating-pdfs) - [Tmux Integration](#tmux-integration) - [Other Projects](#other-projects) - [Contributing](#contributing) - [License](#license) Features =============================================================================== - Create new Entries with interactive survey-like (optional) CLI interface - Delete, lock, unlock single time entries - Edit the currently running entries text, service and project for quickly updating the work log - Read, filter, group time entries to show reports for different time periods - List, sort, filter, update & delete user accounts, customers, projects & services using variable columns and CLI-tables, [CSV](https://en.wikipedia.org/wiki/Comma-separated_values)) or [TSV](https://en.wikipedia.org/wiki/Tab-separated_values) data - Highlight [JIRA](https://www.atlassian.com/de/software/jira) identifiers (`ABC-1279`) and GitHub numeral (`#2121`) hashtags in time entry’s notes (customizable) - auto-completions for most of the sub-commands, options and option values (optional) - Support for standard streams in most of the sub-commands. Other ideas & planned features can be found in the [wiki](./wiki). Report Requirements, Bugs, Issues of any kind: [create a new issue](https://github.com/Ephigenia/mite-cli/issues). ``` Usage: mite [options] [command] _______ _____ _______ _______ _______ _____ | | | | | |______ ___ | | | | | | __|__ | |______ |_____ |_____ __|__ command line tool for time tracking service mite.de https://github.com/Ephigenia/mite-cli/ Options: -V, --version output the version number -h, --help output usage information Commands: amend|reword edit note, service, project of a specific time entry or the currently runnning entry autocomplete install/uninstall autocompletion config show or set configuration settings customer create/delete/list/update customer customers|clients list, filter & search customers delete|rm delete a specific time entry list|st list time entries lock lock single time entry new|create create a new time entry open open the given time entry in browser project create/delete/list/update a single project projects list, filter, archive/unarchive & search projects resume resume most recent entry service create/delete/list/update single service services list, filter & search services start start the tracker for the given id, will also stop allready running entry stop stop any running counter unlock unlock single time entry users list, filter & search for users help [cmd] display help for [cmd] ``` Installation =============================================================================== There are tree different ways to use mite-cli. Please note that all examples in this README.md assume that you have installed mite-cli globally. If not, just replace the `mite` call with `~/node_modules/.bin/mite` or `npx mite-cli`. ## Global npm install -g mite-cli ## Local npm insall mite-cli Then you can call mite-cli binary link created in `node_modules/.bin`: ~/node_modules/.bin/mite ## via NPX Or use it directly using [`npx`](https://www.npmjs.com/package/npx): npx mite-cli Configuration =============================================================================== Before you can start, you’ll need to setup the mite account name ("mycompany" in https://**mycompany**.mite.de) and API key ("Account" -> "My Account"). mite config set account <name> mite config set apiKey <key> The configuration is stored in `~/.mite-cli.json` or whatever you defined in `XDG_CONFIG_HOME`. That also means that right now only one account can be used at a time. There already is an [issue for different configs](https://github.com/Ephigenia/mite-cli/issues/36). Configuration Options -------------------------------------------------------------------------------- - `account` The mite account name, the subdomain part - `apiKey` The user specific apiKey - `currency` defines the currency used for displaying money values - `customersColumns` defines the default columns to be used when running `mite customer list list`. - `listColumns` defines the default columns to be used when running `mite list`. - `noteHighlightRegexp` defines a single regular expression which can contain a single capturing group which will get highlighted. By default this is set to highlight GitHub hashtag notation (f.e. #218) and Jira story identifiers (f.e. CRYO-1281). When you change this note that the beginning and trailing slashes must be omitted and the regexp is case-sensitive and modifiers cannot be changed. It will also highlight duration notes in the content following the `(10:00 to 12:00)` format. - `outputFormat` defines the default output format for the list commands, defaults to `table` - `projectsColumns` defines the default columns to be used when running `mite project list list`. - `servicesColumns` defines the default columns to be used when running `mite services list`. - `usersColumns` defines the default columns to be used when running `mite users`. ### Defaults Configuration options can always be back to the initial value to their default by leaving out the value, like: `mite config set listColumns`. Auto-Completion -------------------------------------------------------------------------------- Since version 0.9.0 mite-cli supports auto-completions for most of the sub-commands arguments, options and option values which make it much easier to use in on the command line. No need to remember user ids or service names anymore as they are suggested when hitting TAB. - Right now auto-completion is only supported and tested on -nix-systems and with the following bash environments: [bash](https://tiswww.case.edu/php/chet/bash/bashtop.html), [fish](https://fishshell.com/) and [ZSH](https://www.zsh.org/) - mite-cli must be installed globally and must be in `$PATH` Before auto-completions can be used you need to install them using the `autocomplete` command: mite autocomplete install When you think you had enough you can uninstall it with mite autocomplete uninstall Usage =============================================================================== Time Entries -------------------------------------------------------------------------------- ### List By default lists today’s time-entries including id, date, project name, revenue, service and the entries note. You can modify this by changing the `listColumns` in the config. (can be changed `mite config set listColumns id,user,project)` When an entry is currently active and tracked it will be yellow and indicated with a little play icon "▶". Also locked entries are greyed out and indicated with a green checkmark "✔" symbol. mite list ┌──────────┬────────────┬───────────────┬────────────┬──────────┬─────────┬───────────────────┬──────────────────────────────────────────────────┐ │ ID │ Date │ User │ Project │ Duration │ Revenue │ Service │ Note │ ├──────────┼────────────┼───────────────┼────────────┼──────────┼─────────┼───────────────────┼──────────────────────────────────────────────────┤ │ 73628791 │ 2017-09-13 │ Bruce Banner │ carservice │ ▶ 01:36 │ - │ Programming │ open in browser │ ├──────────┼────────────┼───────────────┼────────────┼──────────┼─────────┼───────────────────┼──────────────────────────────────────────────────┤ │ 73628761 │ 2017-09-13 │ Bruce Banner │ ABC │ 00:07 │ 9.33 │ Communication │ lorem ipsum dolor │ ├──────────┼────────────┼───────────────┼────────────┼──────────┼─────────┼───────────────────┼──────────────────────────────────────────────────┤ │ 73627950 │ 2017-09-13 │ Bruce Banner │ sp support │ 00:04 │ 4.84 │ Programming │ JIRA-123 Lorem ipsum dolor sit amet, consetetur │ │ │ │ │ │ │ │ │ sadipscing. │ ├──────────┼────────────────────────────┼────────────┼──────────┼─────────┼───────────────────┼──────────────────────────────────────────────────┤ │ 73627919 │ 2017-09-13 │ Bruce Banner │ XYZ │ 00:10 │ 13.33 │ Communication │ Lorem ipsum dolor sit amet, consetetur │ │ │ │ │ │ │ │ │ sadipscing elitr, sed diam nonumy eirmod │ │ │ │ │ │ │ │ │ tempor invidunt ut labore et dolore │ ├──────────┼──────────┼─────────────────┼────────────┼──────────┼─────────┼───────────────────┴──────────────────────────────────────────────────┤ │ │ │ │ │ 00:21 │ 27.50 │ │ └──────────┴──────────┴─────────────────┴────────────┴──────────┴─────────┴──────────────────────────────────────────────────────────────────────┘ #### Filter by time You also can request longer time frames by using the first argument which is basically the [`at` parameter](https://mite.de/en/api/time-entries.html#list-all) of the time entries API: mite list this_month Or Specific dates: mite list 2017-01-02 Or relative weekdays (show entries from last Friday) mite list friday Or relative duration notation (show entries form last 2 weeks) mite list 2w Or Custom periods of time mite list --from 2018-04-01 --to 2018-04-15 Or search for specific entries in all time-entries from the current year mite list this_year --search JIRA-123 #### Other Filters There are various filters to limit the entries shown: - `--from` & `--to` show entries only between two dates or relative dates - `--billable` show only (not-)billable entries - `--tracking` show only tracking/currently running entries - `--customer-id` show entries from a one or more customer(s) - `--service-id` show entries from a one or more service(s) - `--project-id` show entries from a one or more project(s) - `--locked` show only locked or unlocked entries - `--user-id` show entries from one or more user(s) - `--min-duration`, `--max-duration` filter by the duration It can be hard to remember ids, that’s why I recommend using [auto-completion](#auto-completion) which makes it way easier to filter time entries. #### Grouping / Reports For getting a rough overview of the monthly project or services distribution you can use the `--group-by` argument which will group the time entries. This could also be helpful for creating bills. mite list last_month --group-by=service ┌────────────────────┬────────┬────────────┐ │ Communication │ 13:03 │ 994.98 € │ ├────────────────────┼────────┼────────────┤ │ Programming │ 109:27 │ 9387.11 € │ ├────────────────────┼────────┼────────────┤ │ Project Management │ 15:43 │ 1484.48 € │ ├────────────────────┼────────┼────────────┤ │ │ 138:13 │ 11866.57 € │ └────────────────────┴────────┴────────────┘ Or even more groups which also allows splitting between customers: mite list last_month --group-by customer,service ┌─────────────────┬───────────────────┬────────┬────────────┐ │ Soup Inc. │ Communication │ 3:48 │ 361.00 € │ ├─────────────────┼───────────────────┼────────┼────────────┤ │ Soup Inc. │ Programming │ 88:15 │ 1383.75 € │ ├─────────────────┼───────────────────┼────────┼────────────┤ │ Soup Inc. │ ProjectManagement │ 15:20 │ 456.67 € │ ├─────────────────┼───────────────────┼────────┼────────────┤ │ Musterman Corp. │ Communication │ 0:47 │ - │ ├─────────────────┼───────────────────┼────────┼────────────┤ │ Musterman Corp. │ Programming │ 7:35 │ - │ ├─────────────────┼───────────────────┼────────┼────────────┤ │ Beans Gmbh │ Communication │ 8:28 │ 133.98 € │ ├─────────────────┼───────────────────┼────────┼────────────┤ │ Beans Gmbh │ Programming │ 13:37 │ 203.36 € │ ├─────────────────┼───────────────────┼────────┼────────────┤ │ Beans Gmbh │ ProjectManagement │ 0:23 │ 97.81 € │ ├─────────────────┼───────────────────┼────────┼────────────┤ │ │ │ 138:13 │ 2635.15 € │ └─────────────────┴───────────────────┴────────┴────────────┘ #### Advanced Examples When creating a bill for a project create a list of all services worked on in a month on a specific project: mite list last_month --project-id 2681601 --group-by service ┌────────────────────┬────────┬────────────┐ │ Communication │ 13:03 │ 994.98 € │ ├────────────────────┼────────┼────────────┤ │ Programming │ 109:27 │ 9387.11 € │ ├────────────────────┼────────┼────────────┤ │ Project Management │ 15:43 │ 1484.48 € │ ├────────────────────┼────────┼────────────┤ │ │ 138:13 │ 11866.57 € │ └────────────────────┴────────┴────────────┘ In order to fill the details of the services you’ll need all the notes from that specific service. Get the notes for one specific service, a project for the last month to put them on a bill or similar: mite list last_month --project-id 2681601 --service-id 325329 --columns note --plain | sort -u ### Disabling Unicode Characters Some columns like "duration", "hours" add some Unicode characters to f.e. indicate that the time entry is already locked or currently running. This may not be wanted if you’re exporting the entries to a file. You can disable this behavior by setting the (`NO_COLOR`)[https://no-color.org/] variable before calling mite: NO_COLOR=1 mite list --columns date,service,note,duration --plain ### Create Time-Entries #### Interactive When no arguments or just the "note" is given `mite new` asks for more details of the time-entry that should be created. Project, service and duration can be entered in an interactive survey. mite new You can also start by providing a precomposed note mite new "started working on new features" #### Non-Interactive Start creating new time-tracking items right from the command-line. Just pass the things that you’ve done, the project’s name, service name, minutes or the date. The following example will create a 35 minutes entry for the Project "my-project" mite new "created some new nice code" my-project programming 35 The duration values can be the number of minutes or a duration string. When you add a plus sign at the end "+", f.e. "3:12+" the time entry is created and eminently started. mite new "researching colors for project" myProject1 programming 0:05+ #### Shortcuts The program doesn’t provide any feature for fastly creating time entries on the fly but your OS does! Create one or more bash aliase(s) for your most used time entries. The following example creates a bash-alias for creating new running time-entry for a specific project: # ~/.bashrc alias "m1"="mite new Standup ProjectX Meetings 1+"; You can also pass over some arguments like the note for the entry and an optional amount of time if you use bash functions instead of aliases: # ~/.bashrc m() { mite new "$1" ProjectX Programming "${2:-1+}"; } Then you can fastly create new running entries: m standup Or add new entries with a fixed time using the second argument: m "added new feature xy" 3:21 #### Advanced Usage Create a time entries note from the last git commit message: git log -1 --pretty=%B | xargs echo -n | mite new my-project communication 30 Pipe a note’s content (preferably from other outputs) to `mite new`: echo "my new note" | mite new projectx programming 60+ #### Start & Open Entry In case you don’t know what to track exactly or which tasks you’d be doing while you’re doing them you can create a new entry and open the note in an editor. The note will get saved as soon as you close the editor: mite new "started" ProjectX Programmierung 1+ | xargs -n1 mite amend --editor ### Tracker #### Start Tracking Start tracking of a specific time entry. mite start <timeEntryId> #### Resume Tracking Re-start tracking for the most recent entry mite start --last #### Stop Tracking Stops any currently running time entry. mite stop ### Modify Time-Entries #### Change Note When there’s a tracker running you may want to update the note without opening the browser and enter the new details. You can use `amend` or `reword` command which will load the time entry and you can enter the new note. mite amend You can also add the `--editor` option so that your favorite editor opens up with the current note. Make sure your `$EDITOR` is correctly set. mite amend --editor Change the note for the most recently created entry, f.e. for adding some notes mite amend last You can also alter the notes of other time entries when you specify their id mite amend 1847132 You can also pass additional information like the note: mite amend 12345678 "created a programmable list of items" You can also pipe in the note: cat myVerLongNote.txt | mite amend 1234567 #### Change Service or Project Changing the project or service id of the current or any other time entry works the same: mite amend 12345678 --service-id 12834 --project-id 12938123 #### Set Tracked Time Setting the minutes of a specific time entry can be done with `mite amend` and passing a duration string in the format `HH:MM` or specifying the minutes directly: mite amend 123455678 --duration 30 or mite amend 123455678 --duration 0:30 which is both the same and sets the minutes to 30. #### Adding/Removing Time It’s also possible to use the same option (`--duration`) to remove or add some duration. You can still use the `HH:MM` format or minutes directly: mite amend 12345678 --duration +98 which will add 98 minutes to the time entry or remove 12 minutes: mite amend 12345678 --duration -0:12 #### Move Time Entry to another date mite amend 12345678 --date 2020-05-03 #### Un-/Lock Entry Lock a single time entry mite lock 1289736 Unlock a single time entry mite lock 128721 Locking all entries from the last month from a specific customer using `mite list` and `xargs`: mite list last_month --customer-id 128171 --columns id --plain | xargs -n1 mite lock ### Delete entry Delete a single entry mite delete 18472721 Deleting a set of entries filtered using `mite list` and `xargs`: mite list this_month --project-id 128717 --columns id --plain | xargs -n1 mite delete ### Open Opens the organization’s mite homepage in the systems default browser. mite open When a time-entry id is provided opens up the edit form of that entry. mite open 1234567 Users -------------------------------------------------------------------------------- List user accounts while client-side search in name, email & note, sort by email and list only time_trackers and admins. Archived users will be grey. mite user --search frank --role admin,time_tracker --sort email ┌────────────┬──────────────┬─────────────────┬─────────────────────────────┬────────────────────────────────────────────────────┐ │ ID │ User Role │ Name │ Email │ Note │ ├────────────┼──────────────┼─────────────────┼─────────────────────────────┼────────────────────────────────────────────────────┤ │ 123456 │ admin │ Frank Abergnale │ email@host.com │ Lorem ipsum dolor sit amet, consectetur adipisicin │ │ │ │ │ │ g elit, sed do eiusmod tempor incididunt ut labore │ │ │ │ │ │ et dolore magna aliqua. Ut enim ad minim veniam, q │ │ │ │ │ │ uis nostrud exercitation ullamco laboris nisi ut a │ │ │ │ │ │ liquip ex ea commodo consequat. Duis aute irure do │ │ │ │ │ │ lor in reprehenderit in voluptate velit esse cillu │ │ │ │ │ │ m dolore eu fugiat nulla pariatur. Excepteur sint │ │ │ │ │ │ occaecat cupidatat non proident, sunt in culpa qui │ │ │ │ │ │ officia deserunt mollit anim id est laborum. │ ├────────────┼──────────────┼─────────────────┼─────────────────────────────┼────────────────────────────────────────────────────┤ │ 12345 │ time_tracker │ Heinz Frankfurt │ email2@host.com │ │ └────────────┴──────────────┴─────────────────┴─────────────────────────────┴────────────────────────────────────────────────────┘ List archived user accounts mite user --archived ┌────────────┬──────────────┬─────────────────┬─────────────────────────────┬────────────────────────────────────────────────────┐ │ ID │ User Role │ Name │ Email │ Note │ ├────────────┼──────────────┼─────────────────┼─────────────────────────────┼────────────────────────────────────────────────────┤ │ 1234 │ time_tracker │ James Howlett │ email3@host.com │ │ └────────────┴──────────────┴─────────────────┴─────────────────────────────┴────────────────────────────────────────────────────┘ show all-time tracking users from a company (all have a specific email domain) mite users --role time_tracker --email ephigenia.de export all users to a CSV file mite users --columns id,role,name,email,archived,language --json | jq -rM '.[] | @csv' > users.csv Show a report for all users showing the revenues and times per service for all users matching a query mite users --search marc --columns id --plain | xargs mite list last_month --group-by service --user-id Customers -------------------------------------------------------------------------------- List, filter and search for customers. Archived customers will be shown in grey. mite customer list list --search web --sort id ┌────────┬─────────────────┬─────────┬─────────────────────────────────────┐ │ ID │ Name │ Rate │ Note │ ├────────┼─────────────────┼─────────┼─────────────────────────────────────┤ │ 123456 │ WebCompany Ltd. │ 12.34 € │ client’s note │ ├────────┼─────────────────┼─────────┼─────────────────────────────────────┤ │ 827361 │ Solutions Web │ 80.00 € │ Multiline lorem ipsum │ │ │ │ │ Note content │ ├────────┼─────────────────┼─────────┼─────────────────────────────────────┤ │ 927361 │ Mite-Cli │ - │ open source project │ └────────┴─────────────────┴─────────┴─────────────────────────────────────┘ Use different columns mite customer list --colums name,hourly_rate Export all archived customers mite customer list --archived true --json | jq -rM '.[] | @csv' > archived_customers.csv ### Create Customer Use this command to create a new customer. mite customer new --name "Megasoft" --hourly-rate 90 ### Update Customer This command can update a customer’s name, note, hourly rate and archived state. Archive a single customer mite project update --archived false 1238127 Archive multiple customers using xargs: mite customer list --columns id --plain | xargs -n1 mite customer update --archived false ### Delete Customer Delete a single customer mite customer delete 123456 Delete a whole set of customers mite customer list --columns id --archived yes --plain | xargs -n1 mite customer delete Projects -------------------------------------------------------------------------------- List, filter and search for projects. Example showing only archived projects ordered by customer-id in ascending order mite project list --archived yes --sort customer-id ┌───────────────┬──────────────────────────┬─────────────┬──────────────┬────────────┬────────────┐ │ Name │ Customer │ Budget │ Budget │ Budget │ Rate │ │ │ │ │ Used │ Used │ │ ├───────────────┼──────────────────────────┼─────────────┼──────────────┼────────────┼────────────┤ │ Alpha X │ WebCompany (1234) │ 480:00 h │ 330:14 h │ ███████░░░ │ - │ ├───────────────┼──────────────────────────┼─────────────┼──────────────┼────────────┼────────────┤ │ Beta-Test │ WebCompany (1234) │ - │ - │ │ - │ ├───────────────┼──────────────────────────┼─────────────┼──────────────┼────────────┼────────────┤ │ App-Review │ WebCompany (1234) │ 160:00 h │ 0:25 h │ ░░░░░░░░░░ │ 75.00 € │ ├───────────────┼──────────────────────────┼─────────────┼──────────────┼────────────┼────────────┤ │ Deployment │ Example ltd. (73625) │ 80:00 h │ 38:48 h │ █████░░░░░ │ - │ └───────────────┴──────────────────────────┴─────────────┴──────────────┴────────────┴────────────┘ Export all projects using other columns as CSV: mite project list --columns id,customer-id,customer_name --json | jq -rM '.[] | @csv' > projects_export.csv Unarchive all archived projects from a specific customer using `xargs`: mite project list --customer-id 123456 --columns id --plain | xargs -n1 mite project update --archived false ### Create Project Use `mite project new` subcommand to create new projects. There’s currently no support for complicated hourly rates per service. To find out the `customer_id` use either [Auto-Completion](#auto-completion) or copy the id from the `mite project list` list. The following example will create a new Project with an overall budget of 5000 and an hourly rate of 80: mite project new --customer-id 123456 \ --name "Side Project B" \ --hourly-rate 80.00 \ --budget 5000 \ --budget-type cents ### Update Project The `mite project` command can update the details like budget-type, archived state, hourly-rate, name or note of a project. Archive a single project mite project update --archived false 1238127 Set the note and name of a project mite project update --name "js prototype" --note="prototype development" 12344567 Update hourly rate of a project while updating all already associated time entries: mite project update --hourly-rate 9000 --update-entries 1234567 Archive multiple projects using xargs: mite project list --columns id --plain | xargs -n1 mite project update --archived false ### Delete Project Delete a project: mite project delete 123456 Delete all archived projects: mite project list --columns id --archived yes --plain | xargs -n1 mite project delete Services -------------------------------------------------------------------------------- List, filter and search for services. Archived services will be grey. mite service list ┌────────┬───────────────────┬──────────┬──────────┬──────────────────────────────────────────────────────────────────────────────┐ │ ID │ Name │ Rate │ Billable │ Note │ ├────────┼───────────────────┼──────────┼──────────┼──────────────────────────────────────────────────────────────────────────────┤ │ 123456 │ Programming │ 20.00 € | yes │ General Programming │ ├────────┼───────────────────┼──────────┼──────────┼──────────────────────────────────────────────────────────────────────────────┤ │ 123457 │ Consulting │ 30.00 € │ yes │ │ ├────────┼───────────────────┼──────────┼──────────┼──────────────────────────────────────────────────────────────────────────────┤ │ 736251 │ Accounting │ - │ no │ Accounting, invoices etc. │ └────────┴───────────────────┴──────────┴──────────┴──────────────────────────────────────────────────────────────────────────────┘ ### Update Service This command can update a service’s name, note, hourly rate and archived state. Change the hourly rate of a service: mite service update --hourly-rate 8500 123456 Archive a single service: mite service update --archived false 1238127 ### Delete Service Delete a single service mite service delete 123456 Advanced Topics =============================================================================== Cache -------------------------------------------------------------------------------- The cache stores data retrieved from the Mite API. You can clear it up using the `cache` command mite cache clear A common scenario is when data in Mite is updated (e.g. a new customer is added), and Mite-CLI does not reflect the changes. This is because the cache system is preventing Mite-CLI from displaying the updated data. To resolve this issue, simply clear the cache and create a new entry to fetch the latest data from Mite. Columns -------------------------------------------------------------------------------- Every command that produces a tabular output uses a default set of columns per command. You can specify which columns should be shown using the `--columns` option or use `--columns all` to show all available columns. The default column set can be changed per command using the config options that end with `*Columns`. The following example will only show the user and his durations from last week including the sum of the durations: mite list last_week --billable false --columns user,duration ┌──────────────┬────────────┐ │ User │ Duration │ ├──────────────┼────────────┤ │ Bruce Banner │ 0:45 │ ├──────────────┼────────────┤ │ Bruce Banner │ 0:20 │ ├──────────────┼────────────┤ │ Bruce Banner │ ✔ 0:13 │ ├──────────────┼────────────┤ │ Bruce Banner │ ✔ 1:34 │ ├──────────────┼────────────┤ │ Bruce Banner │ ✔ 0:06 │ ├──────────────┼────────────┤ │ │ 2:58 │ └──────────────┴────────────┘ Specifying the columns is important when you want to use the ids of items in other commands with xargs. The following example uses the ids of all time entries to lock them: mite list last_month --columns id --plain | xargs -n1 mite lock Plotting Charts -------------------------------------------------------------------------------- The following command will list all customers from last year and plot their minuets as bar charts to the terminal so that it’s easy to compare the values to each other: mite list last_year --group-by year,customer --columns customer,minutes --plain | jq -rM '.[] | @tsv' \ | sed "$ d" \ | gnuplot -e \ " set style data boxes; set key off; set terminal dumb \"$COLUMNS\" 40; set datafile separator \"\t\"; plot '<cat' every ::1 using 2: xtic(1) "; There are even more charting possibilities using the open-source [gnuplot](http://www.gnuplot.info/). You can also reproduce the charts from the mite admin showing the number of hours worked in the last month: mite list this_month --group-by day --columns day,minutes --plain | jq -rM '.[] | @tsv' \ | sed "$ d" \ | gnuplot -e \ " set style data boxes; set key off; set terminal dumb 120 40; set datafile separator \"\t\"; plot '<cat' every ::1 using 2: xtic(1) "; Which will show the chart: ``` 450 +-------------------------------------------------------------------------------------------------------------+ | + + + + + + + + + + + + + + + + + + + | | | | ******* | 400 |-+ * * +-| | * * | | * * ****** ******* | | * * * * * * | 350 |-+ * * * * * * +-| | * * * * * * | | * * * * * * ***| | * * ******* * * * * * | 300 |-+ * * * * * * ****** * *+-| | ****** * * * * * ******* * * * * | | * * * * * * * * * * * * * | | * * * * * * * * * * * * * | 250 |-+ * * * * * * ******* * * * * ******+-| | ****** * * * * * ****** * * * * * * * * | | * * * * * * * * * * * * ****** * * * * | | * * * * * * * * * * * * * * * * * * | 200 |-+* * * * ****** * * * * * * * * * * * * *+-| | * * * * * * * * * * * * * * ******* * * * | | * * * * * * * * * * * * * * * * * * * | | * * * * * * * * * * * * * * * * * * * | 150 |-+* * * * * * * * * * * * * * * * * * *+-| | * ******* * * * * * * * * * * * * * * * * | | * * * * * * ****** * * * * * * * * * * * | | * * * * * * * * * * * * * * * * * * * | 100 |-+* * * * * * * * * * * * * * * * * * *+-| | * * * * * * * * * * * * * * * * * * * | | * * * * * * * * * * * * * * * * * * * | | * * * ******* * * * * * * * * * * * * * * | _50 |-+* * * * * * * * * * * * * * * * * * *+-| | * * * * * * * * * ******* * * * * * * * * * | | * * * * * * * * * * * * * * * * * * * * | | * + * + * + * + * + * + * + * + * + * + ****** + * + * + * + * + * + * + * + * | +-------------------------------------------------------------------------------------------------------------+ 29 25 24 23 22 19 18 17 16 15 14 12 11 10 09 08 05 04 03 02 01 ``` Alternate Output formats -------------------------------------------------------------------------------- The purpose of the application is to simplify and streamline the interaction with the mite time-tracking service while making the output readable on the command-line. The following formats are supported: - csv (comma-separated) - json, *ignores ansi-colors & table headers* - md (markdown) - table (cli-table) - text (line-seperated), *doesn’t show table headers* - tsv (tab-separated), perfect for inserting into excel or google docs There are alternative output formats which may be useful when you automatically process the results such as `json`, `csv`, `text`: mite list last_week --columns user,id --json | jq -rM '.[] | @csv' Date,User,Duration 2018-11-02,Bruce Banner,1:10 2018-11-01,Bruce Banner,2:30 2018-10-31,Bruce Banner,✔ 2:47 2018-10-30,Bruce Banner,✔ 0:43 2018-10-30,Bruce Banner,✔ 0:10 2018-10-30,Bruce Banner,✔ 0:09 2018-10-29,Bruce Banner,✔ 1:35 2018-10-29,Bruce Banner,✔ 1:21 ,,10:25 This makes it very easy to further process the data, transform it into a HTML page or PDF. Exporting CSVs -------------------------------------------------------------------------------- Creating a time-sheet for your clients can be done like this: mite list last_month --json --columns date,service,note,duration --plain | jq -rM '.[] | @csv' Batch-Edit Time Entries -------------------------------------------------------------------------------- Using Ids from the output for further processing using `xargs`: mite list --columns id --plain | xargs -n1 mite lock Monthly/Daily summary -------------------------------------------------------------------------------- Show only the notes from yesterday’s entries to put them into a standup message: mite list yesterday --plain --columns note --plain Showing all billable entries’ notes of a specific project: mite list last_month --project-id 456 --columns note --plain --billable yes Generating PDFs -------------------------------------------------------------------------------- The most common use case for creating pdfs is when a client asks for a nice looking pdf with the entries from a specific project and timeframe. The mite-cli cannot create pdfs on it’s own but you can use the power of other tools like [jq](https://stedolan.github.io/jq/) & [md-to-pdf](https://www.npmjs.com/package/md-to-pdf): NO_COLOR mite-cli list last_month --project-id 1234 --columns=date,note,duration --json | jq -rM '.[] | @csv' | md-to-pdf > "./time-entries-$(date +%Y%m%d).pdf" `md-to-pdf` can be improved by adding custom stylesheets, templates for headers and footers and can be adjusted to your needs. Tmux Integration ------------------------------------------------------------------------------- Keep track of your daily and monthly efforts right in the status bar of tmux using the [tmux-mite-cli](https://github.com/Ephigenia/tmux-mite-cli) plugin. Currently in alpha stage. Other Projects =============================================================================== - [acari](https://github.com/untoldwind/acari) mite CLI in rust - [mite-clock](https://github.com/iliakur/miteclock) CLI tool for start, stopping time-entries on the fly - [mite-go](https://github.com/leanovate/mite-go) mite CLI in go - [mite-goal](https://github.com/gr2m/mite.goal) web-app displaying targeted monthly time budgets - [mite-overtime](https://github.com/gbirke/mite-overtime) webapp display of calculated overtime values - [mite-reminder](https://github.com/leanovate/mite-reminder) slack application sending notifications for missing time entries - [mite.cmd](https://github.com/Overbryd/mite.cmd) mite CLI in ruby - [Mitey](https://github.com/lionralfs/mitey) mite CLI in javascript Contributing =============================================================================== - [CONTRIBUTING](./CONTRIBUTING.md) License =============================================================================== [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FEphigenia%2Fmite-cli.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FEphigenia%2Fmite-cli?ref=badge_large)