{"_id":"@0x-may/git-peek","_rev":"4-4446ff10a820f65a36b7210555c8bbb3","name":"@0x-may/git-peek","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.1":{"name":"@0x-may/git-peek","version":"1.0.1","keywords":["github","cli","activity","devtools"],"author":{"name":"Mayank"},"license":"ISC","_id":"@0x-may/git-peek@1.0.1","maintainers":[{"name":"0x-may","email":"mayankm1946@gmail.com"}],"bin":{"git-peek":"bin/index.js"},"dist":{"shasum":"11853694c95d6dcdf02217ba73f7fbd112adeb2f","tarball":"https://registry.npmjs.org/@0x-may/git-peek/-/git-peek-1.0.1.tgz","fileCount":12,"integrity":"sha512-Grp84f3Qcw5PsOuEXBGOq7R44VEB2NdYneZsaI177l9SPXxXfC2IV6VRakRL5D8eHiIVyFDb0bhpdfVkyttAAQ==","signatures":[{"sig":"MEUCIGL6lCc4ykd9KTNnrr7paDXD8FJ5cPtp/hKAXTC/4+ynAiEA9XulDkOYv5aH5lSmuEBRHADWNLI/alilUSHm12lXPog=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":23147},"main":"index.js","type":"module","gitHead":"d77465131f345c92651ceb0352d4899ae9f5038e","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"0x-may","email":"mayankm1946@gmail.com"},"_npmVersion":"10.8.2","description":"Peek into your github activity from the terminal","directories":{},"_nodeVersion":"20.19.4","dependencies":{"axios":"^1.13.2","chalk":"^5.6.2","commander":"^14.0.2"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/git-peek_1.0.1_1767620193973_0.985416999952496","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@0x-may/git-peek","version":"1.0.2","main":"index.js","type":"module","bin":{"git-peek":"bin/index.js"},"scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["github","cli","activity","devtools"],"author":{"name":"Mayank"},"license":"ISC","description":"Peek into your github activity from the terminal","dependencies":{"axios":"^1.13.2","chalk":"^5.6.2","commander":"^14.0.2"},"_id":"@0x-may/git-peek@1.0.2","gitHead":"39a43f6634726c1324044b9d30852c9fd2c6cc61","_nodeVersion":"20.19.4","_npmVersion":"10.8.2","dist":{"integrity":"sha512-8bRvVn4O0OOa8VhkVdznpGPO9OqyNLWwiWeMKr6ouF0ijRBsqDnXdXQrM5p8LA3DTV8AubRa6tAjyG+/O03yaQ==","shasum":"7c10641685823dd229340aab527b805e1597ebda","tarball":"https://registry.npmjs.org/@0x-may/git-peek/-/git-peek-1.0.2.tgz","fileCount":12,"unpackedSize":23142,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDg6Qts7/ShH2xSGyi2lw8zeInLngYOOm3FuoCzYTL/EAIgTtde2b7Jr2nUPmFwpozGGye6XMyAMQVg79Uyj5wli70="}]},"_npmUser":{"name":"0x-may","email":"mayankm1946@gmail.com"},"directories":{},"maintainers":[{"name":"0x-may","email":"mayankm1946@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/git-peek_1.0.2_1767620628665_0.692291842109839"},"_hasShrinkwrap":false}},"time":{"created":"2026-01-05T13:36:33.881Z","modified":"2026-01-05T13:43:49.000Z","1.0.0":"2026-01-05T12:49:56.080Z","1.0.1":"2026-01-05T13:36:34.128Z","1.0.2":"2026-01-05T13:43:48.809Z"},"author":{"name":"Mayank"},"license":"ISC","keywords":["github","cli","activity","devtools"],"description":"Peek into your github activity from the terminal","maintainers":[{"name":"0x-may","email":"mayankm1946@gmail.com"}],"readme":"# git-peek\n\n> View your GitHub activity directly from the terminal\n\nA lightweight, secure CLI tool that displays your GitHub contributions, activity, and stats without opening a browser.\n\n\n## Features\n\n- **Secure authentication** with GitHub Personal Access Tokens\n- **Daily activity tracking** - See today's commits, PRs, and issues\n- **Weekly summaries** - 7-day activity overview\n- **Monthly reports** - 30-day contribution history \n- **Local storage** - No external servers, your data stays private\n- **Lightning fast** - Instant results from GitHub's API\n\n## Installation\n```bash\n# Install globally via npm\nnpm install -g @0x-may/git-peek\n\n# Or clone and install locally\ngit clone https://github.com/0x-mayank/git-peek.git\ncd git-peek\nnpm install\nnpm link\n```\n## Getting Started\n\n### 1. Generate a GitHub Token\n\n1. Go to [GitHub Settings](https://github.com/settings/tokens)\n2. Click **Developer settings** → **Personal access tokens** → **Fine-grained tokens**\n3. Click **Generate new token**\n4. Give it a name (e.g., `git-peek-cli`)\n5. Set expiration (30-90 days recommended)\n\n#### Repository Access\n- Select **All repositories** (recommended)\n  - This applies to all current and future repositories you own\n  - Also includes public repositories (read-only)\n\n#### Required Permissions\n\nUnder **Repositories** tab, grant these **read-only** permissions:\n\n- **Commit statuses** - Read-only\n- **Contents** - Read-only  \n  (Repository contents, commits, branches, downloads, releases, and merges)\n- **Issues** - Read-only  \n  (Issues and related comments, assignees, labels, and milestones)\n- **Metadata** - Read-only (Required)  \n  (Search repositories, list collaborators, and access repository metadata)\n- **Pull requests** - Read-only  \n  (Pull requests and related comments, assignees, labels, milestones, and merges)\n\nUnder **Account** tab:\n\n- **Email addresses** - Read-only  \n  (Manage a user's email addresses)\n- **Followers** - Read-only  \n  (A user's followers)\n- **Profile** - Read and write  \n  (Manage a user's profile settings)\n\n**Do NOT grant:**\n- Write access to repositories\n- Admin access\n- Workflow access\n- Secrets access\n\n7. Click **Generate token** and copy it immediately\n8. **Important**: GitHub will not show this token again!\n\n\n### 2. Login\n```bash\ngit-peek login YOUR_TOKEN_HERE\n```\n\nYou should see:\n```\nLogged in as your-username\n```\n\n## Usage\n\n### Check Authentication\n```bash\ngit-peek whoami\n```\nShows your GitHub username, public repos, and follower count.\n\n### Today's Activity\n```bash\ngit-peek today\n```\nDisplays:\n- Commits made today\n- Pull requests opened\n- Issues created\n- Active repositories\n\n### Weekly Summary\n```bash\ngit-peek week\n```\nShows last 7 days of activity with:\n- Daily breakdown\n- Total commits, PRs, issues\n- Active repositories\n\n### Monthly Report\n```bash\ngit-peek month\n```\n30-day activity overview with:\n- Active days count\n- Total contributions\n- Repository activity\n\n### Logout\n```bash\ngit-peek logout\n```\nRemoves stored token and logs you out.\n\n## Example Output\n```\nToday's GitHub Activity\nDate: 4/1/2026\n\nCommits      : 5\nPRs opened   : 2\nIssues opened: 1\nActive repos : git-peek, my-project\n```\n\n## How It Works\n\n- **Authentication**: Uses GitHub Personal Access Tokens (no username/password)\n- **Storage**: Token stored locally in `~/.git-peek/config.json`\n- **API**: Leverages GitHub REST API for recent activity\n- **Privacy**: No external servers, all data fetched directly from GitHub\n- **Security**: Read-only access, token can be revoked anytime\n\n## Security\n\n- Token stored only on your machine\n- No telemetry or tracking\n- No backend servers\n- Read-only GitHub access\n- Token revocable anytime from GitHub settings\n\n## Important Notes\n\n### Activity Tracking vs. Exact Commits\n\n`git-peek` shows **GitHub activity**, not exact commit counts:\n\n- Uses GitHub Events API (limited to ~90 days of history)\n- Counts push events, which may differ from actual commits\n- Best for recent activity tracking (today, week, month)\n- Yearly stats may be incomplete due to API limitations\n\nFor exact contribution data, refer to your [GitHub contribution graph](https://github.com).\n\n## Technical Details\n\n**Built with:**\n- Node.js\n- Axios (HTTP client)\n- Chalk (terminal styling)\n- GitHub REST API\n\n**Requirements:**\n- Node.js >= 14.0.0\n- GitHub Personal Access Token\n\n## Author\n\n**Mayank**\n- GitHub: [@0x-mayank](https://github.com/0x-mayank)\n\n## Show Your Support\n\nGive a ⭐️ if this project helped you!\n\n## Feedback\n\nFound a bug or have a feature request? [Open an issue](https://github.com/0x-mayank/git-peek/issues)!\n\n---\n\nMade with ❤️ by mayank.","readmeFilename":"README.md"}