https://github.com/tbxark/github-status
Generate SVG cards showing your GitHub statistics and programming language distribution
https://github.com/tbxark/github-status
github github-stats readme-profile statistics-images
Last synced: about 1 month ago
JSON representation
Generate SVG cards showing your GitHub statistics and programming language distribution
- Host: GitHub
- URL: https://github.com/tbxark/github-status
- Owner: tbxark
- License: mit
- Created: 2024-12-06T10:17:09.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2026-01-26T10:28:34.000Z (5 months ago)
- Last Synced: 2026-01-27T00:30:30.807Z (5 months ago)
- Topics: github, github-stats, readme-profile, statistics-images
- Language: Go
- Homepage:
- Size: 62.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Status Generator
A tool to generate beautiful SVG cards showing your GitHub statistics and programming language distribution.
[](https://github.com/TBXark/TBXark) [](https://github.com/TBXark/TBXark)
## Features
- Generates an overview SVG card with GitHub statistics
- Creates a languages SVG card showing your programming language distribution
- Highly customizable through environment variables
- Supports excluding specific repositories and languages
- Smart filtering options for forked, archived, and private repositories
- Flexible configuration for multiple GitHub owners
- Webhook support for integration with other services
## Installation
```bash
go install github.com/tbxark/github-status@latest
```
## Usage
## Configuration
All configuration is done through environment variables. Here are all the available options:
| Environment Variable | Type | Description | Default |
|---------------------------------|----------|-------------------------------------------------------|--------------|
| `ACCESS_TOKEN` / `GITHUB_TOKEN` | string | GitHub access token for API authentication | Required |
| `CUSTOM_ACTOR` / `GITHUB_ACTOR` | string | GitHub username | Required |
| `EXCLUDE_REPOS` | string[] | Comma-separated list of repositories to exclude | `[]` |
| `EXCLUDE_LANGS` | string[] | Comma-separated list of languages to exclude | `[]` |
| `INCLUDE_OWNER` | string[] | Comma-separated list of GitHub owners to include | `[username]` |
| `IGNORE_PRIVATE_REPOS` | bool | Whether to ignore private repositories | `false` |
| `IGNORE_FORKED_REPOS` | bool | Whether to ignore forked repositories | `false` |
| `IGNORE_ARCHIVED_REPOS` | bool | Whether to ignore archived repositories | `false` |
| `IGNORE_CONTRIBUTED_TO_REPOS` | bool | Whether to ignore repositories you've contributed to | `false` |
| `IGNORE_LINES_CHANGED` | bool | Whether to ignore lines of code changed in statistics | `false` |
| `IGNORE_REPO_VIEWS` | bool | Whether to ignore repository view counts | `false` |
| `WEBHOOK_URL` | string | URL for webhook notifications | `""` |
| `ANIMATION` | bool | Whether to enable animation in the SVG cards | `false` |
> **Note:** `GITHUB_TOKEN` is limited requests on GitHub API, so it is recommended to use a personal access token `ACCESS_TOKEN` with the `repo` scope.
## Best Practices
Reference [My GitHub Action](https://github.com/TBXark/TBXark/blob/master/.github/workflows/update-status.yml)
Create a repository action to automatically update the stats. The action will update the stats and push the changes to the main branch. And you can use it svg card in your README.md.
## Thanks
This project was inspired by the [jstrieb/github-stats](https://github.com/jstrieb/github-stats) project
## License
**github-status** is released under the MIT license. [See LICENSE](LICENSE) for details.