Skip to content

This is some scripts i have made to Ceep my github streak. The way it works is that It commit's a message into the README.md file once a day while the machine is running.

Notifications You must be signed in to change notification settings

Crisstuff/ceepGithubStreak

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ceep Github streak

This is a program that im running on a raspberry pi 5 to Ceep my github streak. It commit's a massage into this README.md file once every day its running.

Tools:

  • crontab -e
  • bash

scripts:

  • Mac OS script = macscript.sh
  • Raspberry pi script = raspscript.sh
  • No version for windows

NOTE: I have just tried this to run this on a raspberry pi 5 with linux mint installed dont know if it will need a different setup if there is another distro.

How it works

  • This project uses crontab to set a rimainder to run this script once every day
  • The script.sh file contains a bash script that opens the README.md file and types a massage to Ceep Github streak 🎉
  • The script also count's the Total count and + 1 for each time it runs

Conditions to the script:

  • See the Highest held streak: If the streak is higher than the Highest held streak the Total count now amount becomes the new Highest held streak amount.

  • Add the last time the streak was updated in the Last updated to see the last date it was updated.

  • Show the Total count now of the streak by counting the massages under the List of prints.

  • If the Last updated date isnt from the day erlyer the List of prints gets viped and the Total count now gets set back to 0.

  • NOTE: This project is still under development so all the condisions may not be put into practice yet

Version for Linux & Mac OS

How to sett this up on MAC

  1. Clone this repositorry

  2. Open the README.md scroll to the bottom of the file and change the information under Times this ceepGithubStreak have run

    From this To this
    Highest held streak: 1 days Highest held streak: X days
    Last updated: 23.11.2025 Last updated: DD.MM.YYYY
    Total count now: 1 Total count now: 0

    And delate all the This is a message comments under the List of prints.

    This resets the the README.md to production.

  3. In the terminal type chmod +x script.sh & klikk enter | This will make the script runeble.

  4. Open the project and type this in the terminal vindow pwd | This will show the file path to your project copy the file path.

  5. Type this in the terminal window crontab -e | To write shift I this means Insert.

  6. Type in 00 00 * * * & your file path & script.sh | remember that.

    After you have done this it should look something like this | 00 00 * * * cd /path/to/your/repo && ./script.sh.

    Then klikk esc to get out of Insert mode, Then write :wq this means write quit and saves your changes.

  7. Now you`ll just have to have your machene run constantly and the script will run 12:00 every day 👍

How to set this up on a raspberry pi 5

  • Work in progress

Times this ceepGithubStreak have run:

This part of the README will be where the commits are happening. The list under will be updated every day the script is running under List of prints you will see all the massages that has been commited in your current streak. NOTE: The info for to update each day is beaing calculated using the date in Last updated. I recomend to not try to edit any of the information under so that you dont messup the streak.

Highest held streak: 1 days

Last updated: 17.01.2026 Last updated: 17.01.2026

Total count now: 1

List of prints:

This is a message - 04.01.2026 16:01:41 This is a message - 04.01.2026 16:10:21 This is a message - 04.01.2026 16:35:00 This is a message - 06.01.2026 12:00:01 This is a message - 06.01.2026 12:10:00 This is a message - 17.01.2026 12:10:00

About

This is some scripts i have made to Ceep my github streak. The way it works is that It commit's a message into the README.md file once a day while the machine is running.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published