timelog-extract 0.3.1

Aggregate local work activity from Gemini, Claude, Cursor, OpenAI Codex IDE, Chrome, Mail, worklog, optional GitHub public activity, and optional Screen Time.

Gittan

Timelog Extract

Local time reports from how you actually work.

Your day leaves traces—IDE, browser, mail, commits, worklog. Gittan turns those signals into project hours and optional invoice PDFs, without sending your raw activity to our servers by default. Everything runs local-first; you stay in control.

---

Install

You need Python 3.10+. The fastest path is the one-line installer — it uses pipx under the hood (falling back to pip install --user if pipx is missing) so gittan lands on your PATH:

curl -fsSL https://gittan.sh/install | bash
gittan -V

Prefer the manual steps? Install with pipx directly:

python3 -m pip install --user pipx
python3 -m pipx ensurepath
# open a new shell, then:
pipx install timelog-extract
gittan -V

Other install paths

pip install --user — scripts may land outside your default PATH. Add the user-level bin for that Python install (OS-specific; python3 -m site --user-base helps locate it), or run gittan doctor after install for hints.

python3 -m pip install --user timelog-extract

Virtualenv

python3 -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install timelog-extract

From source

git clone https://github.com/mbjorke/timelog-extract.git
cd timelog-extract
python3 -m pip install -e .
gittan -V

A Homebrew tap (brew install gittan) is planned; until then use the installer or pipx above. Maintainer notes: docs/runbooks/homebrew-tap.md.

Maintainers: release steps — docs/runbooks/versioning.md.

---

First run

Use a git checkout (usually the repo root) and lock your worklogs to per-project files:

1. gittan doctor — see what collectors can see on this machine.
2. gittan setup — wire optional hooks and timelog_projects.json (--dry-run / --interactive if you want previews).
3. gittan report --today --source-summary — your first real report from real traces.

Projects config default path (--projects-config when omitted):

1. GITTAN_PROJECTS_CONFIG if set (full path to config file).
2. Else $GITTAN_HOME/timelog_projects.json if GITTAN_HOME is set.
3. Else the canonical file under the Gittan home directory (gittan config path shows the exact path; same target when the file does not exist yet).
4. Else the per-user profile home fallback if that older file exists.

Resolution does not depend on the current working directory. A stray home-directory or repo-local copy is ignored (with a warning on gittan report / gittan doctor). Use --projects-config only for demos or deliberate overrides.

You usually do not need to set any env vars; check the active path with gittan config path.

Worklog model (locked standard):

• Primary: per-project files in ~/.gittan/worklogs/<project-id>.md.
• Store each path in that project profile as "worklog" inside timelog_projects.json.
• Legacy fallback: repo-local TIMELOG.md remains supported for compatibility, but is not the recommended default.

Legacy fallback resolution order (same order as AGENTS.md and CONTRIBUTING.md):

1. --worklog PATH if you pass it.
2. Else the top-level worklog field in timelog_projects.json, if set.
3. Else TIMELOG.md in the current working directory, if that file exists.
4. Else <current_repo_root>/TIMELOG.md, with <current_repo_root> from Git (git rev-parse --show-toplevel) when you are inside a repository, otherwise the current directory.

---

Commands you’ll use

Goal	Command
Interactive report (asks for dates if you omit them)	gittan report
Today / last week / range	gittan report --today · --last-week · --from YYYY-MM-DD --to YYYY-MM-DD
Map URL hosts to projects	gittan review (or gittan review --json for read-only candidates)
Clean up uncategorized time (legacy)	gittan review --uncategorized
Quick totals	gittan status --today
Collector status	gittan sources
Edit project rules	gittan projects
Show active config path/source	gittan config path
Repo-wide git → worklog hooks	gittan setup-global-timelog

JSON / HTML export (for scripts or archiving):

gittan report --today --format json
gittan report --from YYYY-MM-DD --to YYYY-MM-DD --format json --json-file out/truth.json --report-html out/report.html

out/ is local output (gitignored by default). Optional GitHub activity: set GITHUB_USER / --github-user, optional GITHUB_TOKEN — details in docs/sources/sources-and-flags.md.

---

Timelog vs config

Per-project worklogs (~/.gittan/worklogs/<project-id>.md)	Primary standard; each profile in timelog_projects.json should carry explicit "worklog" path.
TIMELOG.md	Legacy fallback (compatibility only); still supported for existing setups.
timelog_projects.json	Machine rules; back it up. Setup writes timestamped backups before replacing broken JSON.

---

Troubleshooting

Symptom	Where to look
gittan not found	PATH (pipx ~/.local/bin, or pip --user bin); then gittan doctor.
No events / empty sources	docs/sources/sources-and-flags.md
Bad or missing config	gittan setup · backups timelog_projects.backup-*.json
Permissions / paths	--worklog, browser DB access, Mail / Screen Time
Global hooks	docs/runbooks/global-timelog-setup.md

---

Documentation

Layered docs so you can go shallow or deep:

• Find any category of doc — docs/README.md is the map.
• See how vision, scope, and metrics fit together — docs/product/vision-documents.md.
• Use the Cursor companion (optional) — cursor-extension/README.md.
• Call the same engine from a script — python3 scripts/run_engine_report.py --today --pdf.

---

Contributing · tests · license

If you want to change the tool, start with CONTRIBUTING.md — it covers branch names, English PR titles and descriptions, and what to run locally before review.

• Branch like this: short-lived task/<scope> from main, then open a PR — spelled out in BRANCH.md.
• Understand CI: what GitHub runs on every push is in docs/runbooks/ci.md.
• Match CI before you push: bash scripts/run_autotests.sh from the repository root.
• Deeper rules for humans and agents: AGENTS.md — timelog policy, push gates, review cadence.
• License: GNU GPL-3.0-or-later — copyleft; share improvements on the same terms.
• What shipped when: CHANGELOG.md.
• Logos, favicon, social preview: docs/brand/README.md for maintainers building assets from canonical marks.

---

Feedback

Questions and rough edges → GitHub Discussions. Bugs you can reproduce → Issues.