The guide · English

User guide

The complete illustrated guide to personal workspaces, teams, timers, notes and reports.

Version 0.1.0 · English documentationMarkdown documentation ↓

English videos with narration, music and subtitles: introduction, getting started and all 12 video guides.

This guide covers the features delivered in version 0.1.0. Screenshots contain fictional data. Some detailed screenshots show the French interface; the layout and actions are shared across languages. Project names, descriptions and notes keep their original language.

English interface
English interface

1. Choose how to use Minutrel

ModeData and accountConnection
Standalone desktopOne personal workspace on this computer; no online accountNo server required for projects, time tracking, manual entries, notes, manual summaries or local exports
Desktop connected to a teamYour account on the team server, with a personal local copyConnect online once; then record timer actions and new time entries offline
Web browserYour account and data on the team serverServer connection required; the browser does not provide a standalone workspace

Always choose a Minutrel project, never a folder on your computer. AI is optional and no model is bundled.

2. Start without a server

Install the package for your operating system. V0.1 packages are unsigned test packages. On the sign-in screen choose Use on this computer. If already connected to a team, open Settings → Open my personal workspace.

Create your first project in Projects → New project. Your personal workspace has one profile, protected by your operating system account. It needs no email address, password or online service. Change the workspace name and time zone in Settings before recording time; the time zone is fixed after the first entry.

Standalone workspace, French example
Standalone workspace, French example

Data is written to the app’s private folder with a previous-state copy. Use Export local copy regularly and back up the entire app configuration folder. The JSON copy also contains private notes. Opening the personal workspace does not send it to a team.

3. Join a team and understand roles

Your administrator supplies the server’s HTTPS address and your account. Open that address in your browser. On desktop choose Open a team workspace, enter the same server address and sign in with the same account. HTTP is accepted only for a server on this computer.

RolePermissions in V0.1
ContributorOwn time entries, notes and personal reports; assigned projects
ManagerAll projects and team time entries, including corrections with a reason
AdministratorThe above plus accounts, integrations, collective monthly exports and the activity log

In Team → Add a member, administrators create accounts with an initial password of at least 12 characters. Share it privately; the member can change it in settings. Edit changes the role or enabled state. Disabling an account revokes access while retaining history. The last active administrator cannot be removed. Stop a member’s timer before disabling them; the timer action lets an administrator resolve a forgotten timer with a recorded reason.

Team management, French example
Team management, French example

Invitations by email, SSO and project-specific management roles are not part of V0.1. The manager role covers the whole team.

4. Projects, tasks and archiving

In Projects, search or switch between active and archived projects. Managers and administrators create or edit the name, description, colour and assigned members. Tasks adds or archives optional tasks. Contributors see assigned projects. In a standalone workspace you manage your own projects.

Projects, French example
Projects, French example

Stop active project timers before archiving. Archiving preserves historical time entries.

5. Track time and use the mini timer

In Overview, choose a project, optionally a task, describe the work and click Start. Pause stops counting without finishing the entry; Resume continues it. Finish saves the completed time. Breaks are excluded.

Mini timer opens a movable window above ordinary windows. Desktop also offers a system tray/menu bar icon and Ctrl/Cmd + Alt + M, when available. The widget resizes to its content; Minutrel opens the main window and the cross hides the widget. Full-screen applications and some Linux/Wayland environments impose their own window rules.

Standalone widget tested with the server stopped
Standalone widget tested with the server stopped

Closing a window or quitting does not finish a timer. Personal timers remain in the local journal; team timers already accepted continue on the server. Computer sleep is not an automatic pause. Finish explicitly when work ends.

On the web, a compact bar remains during navigation. A separate mini window is available when the browser supports Document Picture-in-Picture; otherwise use the bar.

6. Work offline and synchronise

StatusMeaning
Local workspacePersonal work saved only on this computer
Workspace synchronisedServer reachable and no local changes awaiting acceptance
Waiting to syncTime entries saved locally and not yet accepted by the server
OfflineDesktop timer actions and new manual entries remain recordable; team administration requires the server
Conflict to resolveThe server rejected a version, assignment or overlap; local proposals remain saved

An initial online connection prepares your account, assigned projects and current timer. The outbox survives closing the app. Sending resumes when the server is reachable; Settings → Synchronise retries. An expired session may require signing in again to the same account. Do not delete app data while changes are pending. Opening a team cache after 30 days without account verification requires a connection; the standalone personal workspace has no such deadline.

A team timer saved during an outage, shown in French
A team timer saved during an outage, shown in French
The same entry received once on the web, shown in French
The same entry received once on the web, shown in French

Avoid recording the same interval from several offline devices. The server rechecks permissions, overlapping intervals and the active timer. It never silently replaces another device’s history.

To resolve a conflict, finish the local timer, export a local copy and compare the server state. Archive the queue and keep the server state preserves proposals in local archives and reloads the server. Re-enter genuinely missing time manually after checking it. V0.1 does not merge divergent histories automatically. Editing team projects, correcting server entries, team reports and AI configuration need a connection. A cached personal preview is not a complete collective report.

7. Transfer personal work to a team

Finish personal timers, open your team account and go to Settings → Transfer my local work → Read my local workspace. Map each selected personal project to an existing, authorised team project. Unmapped projects remain local.

Completed entries are copied to your team account; originals stay on the computer. Tasks are not recreated and private notes are not sent. A repeated transfer recognises entries already received. Keep the same project mapping after the first send; changing it requires resolving a conflict. Personal and team workspaces are not merged automatically, and this is not synchronisation between two teams.

Mapping a personal project to a team project, shown in French
Mapping a personal project to a team project, shown in French

8. Manual entries and corrections

Time entries filters by month. Managers and administrators can select another member. Lists are paginated; wide tables can scroll horizontally on small screens.

Add time → Duration accepts 1h30, 90 min or 1.5 h for today or a past work date, up to 24 hours per entry. Start and end accepts a wholly past interval up to seven days, with an explicit UTC offset, such as +01:00 or +02:00 in Paris depending on the season. Confirm intentional overlaps; the server checks them again during synchronisation.

Manual entry, French example
Manual entry, French example

The pencil corrects a completed entry with a reason. Description preserves the original segments and seconds. Duration or Start and end replaces segments; the old value and reason are recorded. The cross removes an entry from reports with a reason. A stale version requires refreshing before another correction. Team corrections require a connection. The standalone correction log retains up to 1,000 recent correction records.

9. Notes, summaries and AI

In Work journal → Add a note, choose the project, work date and text. A private note is visible only to you and assistants you explicitly permit to read it. Review / share controls inclusion in team reports. Deleting a note is permanent and asks for confirmation in the app.

Write prepares a manual monthly summary. Use Review and approve, edit and approve the text to include it in reports. Drafts stay private.

Work journal, French example
Work journal, French example

An administrator can configure Ollama, vLLM or Claude under Integrations. Prepare with AI asks for a month, a provider and consent to send your own descriptions and notes, including private notes, to that provider. Review the private draft before approval. AI never changes the calculated time totals. Real providers require configuration and testing on your infrastructure; no paid subscription is supplied. Standalone mode supports manual notes and summaries; these AI integrations use the team server.

10. Monthly reports and exports

In Reports, choose the month. Team administrators select employees under Entire team, including disabled members’ history, then download CSV, PDF or ZIP archive. Other roles view their own report. Standalone exports contain personal local work.

Report and export buttons, French example
Report and export buttons, French example

Totals use exact completed seconds, excluding breaks, deleted entries and active timers. Intervals crossing a month boundary are split in the workspace time zone, including daylight-saving changes. Private notes and unapproved summaries are excluded.

CSV uses UTF-8 and semicolons; server report labels follow the selected language, while personal CSV columns remain stable for other tools. PDF is paginated. Team ZIP contains time CSV, project totals, a collective PDF and individual PDFs. Personal ZIP contains CSV, PDF and report JSON.

Server exports are private snapshots, available to the creating administrator for 24 hours. Later corrections do not change that snapshot. Limits: 100 members and 20,000 entries per team export; the on-screen preview shows 100 entries with complete totals. For a definitive team report, first synchronise members’ work and stop active timers.

11. Codex, Claude Code, API and webhook

In Integrations → Create access token, choose a name, expiry and the smallest set of permissions. Copy the secret once. Set up my assistant provides Codex and Claude Code configurations. Store the token in MINUTREL_MCP_TOKEN, outside source control. Revoke stops access.

Integrations, French example
Integrations, French example

Timer control is a separate permission, disabled by default. Even an administrator’s token is personal. Assistant notes start as private drafts. REST uses application sessions; MCP tokens do not grant general REST or team export access.

An automation tool can call POST /hooks/work-notes with a token granting work.draft_own, a unique Idempotency-Key, and projectId, workDate, text. The result is a private note for review, never hours or a shared note. Repeated keys are retained for 30 days. See the API/webhook contract for the full HTTP example and error codes. Outgoing webhook subscriptions are not included in V0.1.

12. Languages, settings and accessibility

Use Français / English / Deutsch on sign-in or in the header. Changing language reloads the interface, so save forms first. Dates and labels change; user content and exact durations do not. Native operating system controls may use the system language.

On smaller screens, navigation becomes a horizontal bar and tables scroll sideways. The skip link, labelled buttons and reduced-motion support help keyboard use. Responsive checks are distinct from a full accessibility audit. See the mobile screenshot.

Settings contains your password, server address and, for administrators, workspace configuration, shared-work JSON export and the activity log. Password changes revoke previous access. A workspace JSON export is not a full server backup.

13. Backup and troubleshooting

For servers, use the backup/restore procedure and self-hosting guide. Keep the database and encryption key together. For standalone desktop, quit the app and copy its entire configuration folder, including offline-*.json, .bak and connection.json. Typical locations are ~/Library/Application Support/app.minutrel.desktop on macOS, %APPDATA%\app.minutrel.desktop on Windows and $XDG_CONFIG_HOME/app.minutrel.desktop or ~/.config/app.minutrel.desktop on Linux. A JSON copy is also exportable from settings; restoration through the interface is not included.

ProblemCheck
No projectsAsk for an assignment, or create a personal project
Server unreachableCheck URL, HTTPS, certificate and network; AI is not needed for timers
Missing report timeStop the timer; check month, time zone, member and outbox
Conflict or revoked rightsKeep local files, export a copy and contact the administrator
Missing widgetUse the main window, menu bar icon or mini timer button; check full-screen and shortcut rules
AI unavailableCheck provider and allowed hosts; write the summary manually meanwhile

For a bug report, include version, OS, local/team mode, steps and message. Remove passwords, tokens, private notes and team data from screenshots. Report vulnerabilities through the security channel, without posting exploit details publicly.

Delivered scope · Recorded validation · GitHub publication. Advanced technical documents are currently maintained in French.

MINUTREL / VIDEO

Watch the guide.

Follow the real interface, with English narration and subtitles.

Browse all videos ↗

02 / ENGLISH · VOICE & MUSIC

Minutrel — Getting started: track, pause, finish and report

Follow a project from selecting it and recording a session to adding time, sharing a note and exporting a report.

05 / ENGLISH · VOICE & MUSIC

Minutrel — Set up your team, roles and project assignments

Bring people and projects together, with clear roles and shared time tracking.

13 / ENGLISH · VOICE & MUSIC

Minutrel — Custom subcategories for your projects

Create a project subcategory and keep it with a time entry and its work description.

Ctrl/Cmd + K to open · Escape to close · Search stays on this site.