Skip to content

apappas1129/git-synced

Repository files navigation

npm version npm downloads Test license

git-synced

waku waku git-synced

git-synced is a tool that generates empty commits that mirror the contribution graph from a secondary GitHub profile, plotting those contributions on your primary account. Published on npm as @apappas1129/git-synced.

How to use

git-synced is a CLI you run from inside the git repository you want the mirrored commits added to — this should be a repository of your own, tied to your primary GitHub account. It does not need to be related to this tool's source in any way.

  1. Browse to your secondary GitHub account's profile page and ensure that your desired date range of contributions graph is correctly set.

    For example, set the parameters from=2024-01-01&to=2024-12-31.

    https://github.com/apappas1129?tab=overview&from=2024-01-01&to=2024-12-31
    
  2. Save the entire HTML of the profile page anywhere on disk, e.g. profile.html.

  3. cd into the git repository you want the commits created in, then run the tool with no install:

    npx @apappas1129/git-synced

    Or install it globally once and reuse the git-synced command anywhere:

    npm i -g @apappas1129/git-synced
    git-synced
  4. Follow the prompts. When asked for the HTML file, point it at the file you saved in step 2 (a relative or absolute path both work).

Flags

Flag Description
-f, --file <path> Path to the saved GitHub profile page HTML. Skips the interactive file-name prompt.
-v, --version Print the version number.
-h, --help Show usage information.
git-synced --file ./profile.html

Why are my contributions not showing up?

  • Commits made less than 24 hours ago may not appear immediately.
  • Ensure your commits meet GitHub's criteria for contributions.

※ See GitHub Docs - Contributions that are counted

Important Notes

  • This script creates empty commits and does not transfer any actual code or content.
  • Excessive or inappropriate use of this tool could be seen as gaming the system and may have consequences for your GitHub account.

Ethical Considerations

  • Only use this tool to consolidate your own contributions from multiple accounts.
  • Do not use this to misrepresent your activity or skills on GitHub. Respect the integrity of the GitHub contribution graph as a reflection of actual work and collaboration.

This repository is created after isturiz/sync-graph. If your secondary GitHub account is accessible publicly, I recommend using this tool instead to skip the need of manually creating the HTML file containing your secondary account's contribution graph.

About

Generate empty commits by mirroring the commit history from a secondary GitHub profile to plot contributions on your primary account.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors