https://github.com/iquiw/emacstreak
GitHub streak stats on Emacs
https://github.com/iquiw/emacstreak
emacs github
Last synced: 10 days ago
JSON representation
GitHub streak stats on Emacs
- Host: GitHub
- URL: https://github.com/iquiw/emacstreak
- Owner: iquiw
- Created: 2026-03-22T15:31:17.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-03-22T15:41:38.000Z (3 months ago)
- Last Synced: 2026-03-23T06:47:25.564Z (3 months ago)
- Topics: emacs, github
- Language: Emacs Lisp
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Emacstreak
GitHub streak stats on Emacs.
This is a feature-less port of [DenverCoder1/github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats) in Emacs Lisp.
## Features
- SVG card of the following stats.
- Total contributions
- Current streak
- Longest streak
- Themes as in `github-readme-streak-stats`.
- Written in Emacs Lisp.
### Unimplemented features
- No customizable [options in github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats?tab=readme-ov-file#-options) except for `user` and `theme`.
## Setup
### Installation
Clone the repository from GitHub.
```console
$ git clone https://github.com/iquiw/emacstreak.git
```
Add the directory to `load-path` and require `emacstreak`.
```emacs-lisp
(add-to-list 'load-path "/path/to/emacstreak")
(require 'emacstreak)
```
### Configuration
Specify GitHub token in the environment variable `GITHUB_TOKEN` or Emacs
variable `emacstreak-github-token`.
```emacs-lisp
(setopt emacstreak-github-token "github_pat_...")
```
To configure theme, specify theme name in the environment variable
`EMACSTREAK_THEME` or its symbol to `emacstreak-theme` variable.
Refer to [github-readme-streak-stats/docs/themes.md](https://github.com/DenverCoder1/github-readme-streak-stats/blob/main/docs/themes.md) for available themes.
```emacs-lisp
(setopt emacstreak-theme 'nord)
```
## Usage
### Interactive display
M-x `emacstreak-show-svg` shows SVG card of the specified user
without animation in the popup buffer.
With the prefix-argument, it uses the last queried stats instead of
querying GitHub GraphQL API.
It is useful when trying different theme as the query usually takes some time.
### Interactive save
M-x `emacstreak-save-svg` saves SVG card of the specified user in
the specified file.
With the prefix-argument, it uses the last queried stats instead of
querying GitHub GraphQL API.
It is useful when trying different theme as the query usually takes some time.
### Batch save
Provided that environment variable `GITHUB_TOKEN` is defined, the following
command outputs SVG card of `` into ``.
```console
$ emacs --batch -L . -l emacstreak.el --eval '(emacstreak-save-svg "" "")'
```
### GitHub Action
By GitHub Action, SVG card of `` with `` can be generated and
saved to `` like follows.
```yaml
- uses: actions/checkout@v6
with:
repository: iquiw/emacstreak
path: emacstreak
- name: Setup Emacs
uses: purcell/setup-emacs@master
with:
version: 30.2
- name: Generate streak stats card
run: |
emacs --batch -L emacstreak -l emacstreak/emacstreak.el --eval '(emacstreak-save-svg "" "")'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
EMACSTREAK_THEME:
```
## Acknowledgments
SVG generation and stats calculation logic are heavily drawn from
[DenverCoder1/github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats), though not the same.