Quick Start

Follow this complete guide to get started with gitmomos. We've designed a powerful workflow that stays out of your way while keeping your team consistently informed.

Installation & Setup

Step 1 — Create Account

Start by visiting our signup page. You will need to provide a username, your work email address, and a secure password to create your cloud dashboard profile. Signup page

Step 2 — Install CLI

Gitmomos is a terminal-native tool. Install it globally on your machine using npm:

npm install -g gitmomos

Step 3 — Login via CLI

Authenticate your terminal instance using the credentials you created on the website.

gitmomos login

Step 4 — Add a Project

Navigate to your local git repository and link it. You will be prompted to provide a project name and confirm the repository path.

gitmomos add "Project Name"

Daily Workflow

Step 5 — Sync Work

At the end of your session, run the sync command. The CLI extracts your commit metadata and pushes it securely to our database. This metadata is then queued for AI processing.

gitmomos sync

Step 6 — AI Report Generation

You don't need to write manual updates anymore. Our backend processes your synced metadata and generates a cohesive, natural language report. Note: Reports are generated asynchronously by our AI pipeline.

Step 7 — View Reports

Open the gitmomos web dashboard to view your generated Daily reports, Weekly high-level summaries, and visual Activity graphs mapping your productivity trends.

Step 8 — Manual Reports

Not all work results in code commits. If you spent the day locked in research, planning, or meetings, you can easily log into the dashboard and append manual reports explicitly categorizing non-coding work hours.

Step 9 — Notifications

Never miss a standup update. If the system detects no git syncs or manual reports near the end of your day, you will receive an automated email reminder. You can directly reply or mark the day as "absent/PTO" gracefully within the UI dashboard.

Session Management

Step 10 — Log Out

If you are using a shared machine or simply wish to clear your session, use the logout command to securely remove your credentials from the OS keychain.

gitmomos logout