Skip to main content

Zero-config, language-agnostic Git snapshots via tags

Project description

Git Checkpoints

🔄 Zero-config, language-agnostic Git snapshots via tags.


🚀 Installation

Option 1: NPM Package

npm install -g git-checkpoints

Option 2: Python Package

pip install git-checkpoints

Option 3: Bash Script (One-Line Install)

curl -LsSf https://raw.githubusercontent.com/moussa-m/git-checkpoints/main/install.sh | bash

Both methods:

  • Install git-checkpoints into your PATH
  • Add git checkpoint / git checkpoints aliases in this repo
  • Schedule auto-snapshot every 5 minutes when changes exist (configurable)

❌ One-Line Uninstall

git-checkpoints uninstall

Removes the global CLI and all cron entries.


💻 Usage

Git aliases (in your repo)

git checkpoint [name]      # create a checkpoint
git checkpoints list       # list all checkpoints
git checkpoints delete *   # delete one or all
git checkpoints load <name># restore a checkpoint

Direct CLI

git-checkpoints create [name]
git-checkpoints list
git-checkpoints delete <name|*>
git-checkpoints load <name>
git-checkpoints auto
git-checkpoints pause              # pause auto-checkpointing
git-checkpoints resume             # resume auto-checkpointing
git-checkpoints config <get|set>   # manage configuration
git-checkpoints local-uninstall
git-checkpoints uninstall

⚙️ Configuration

Control auto-checkpointing behavior with the config command:

git-checkpoints config get                    # show all settings
git-checkpoints config get interval           # show current interval
git-checkpoints config get status             # show current status
git-checkpoints config set interval 10        # set interval to 10 minutes

Available options:

  • interval - Auto-checkpoint interval in minutes (default: 5)
  • status - Current status: paused or running

Examples:

# Set checkpoints every 15 minutes
git-checkpoints config set interval 15
git-checkpoints resume  # apply new interval

# Check current configuration
git-checkpoints config get
# Output:
# ℹ️ Current configuration:
#   interval: 15 minutes
#   status: running

🛠 Troubleshooting

  • git-checkpoints not found? Ensure your install dir (e.g. ~/.local/bin) is in $PATH.

  • No snapshots?

    • Check uncommitted changes: git status
    • Trigger one manually: git checkpoint
  • Cron not running?

    • Verify service: systemctl status cron
    • Check crontab: crontab -l | grep git-checkpoints

Enjoy effortless, zero-config backups of your work-in-progress!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

git_checkpoints-2.0.2.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

git_checkpoints-2.0.2-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

Details for the file git_checkpoints-2.0.2.tar.gz.

File metadata

  • Download URL: git_checkpoints-2.0.2.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.9

File hashes

Hashes for git_checkpoints-2.0.2.tar.gz
Algorithm Hash digest
SHA256 8dd386c76f5de15f5f3beae94b3575ae2e51c2756f2d6c0fb6a63e039fe814f9
MD5 fc696ff3b04b5f3e8a9a091717b538ed
BLAKE2b-256 fcaed16b0fe0e715067e3c16d23ce933be365f8798c1cd00acaa0ef5b7e22753

See more details on using hashes here.

File details

Details for the file git_checkpoints-2.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for git_checkpoints-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 351fc02b5b24786f096e3a5a672d2ad2ab3fc8b9960e8a353f04d389fd84b177
MD5 f21359f52a53a93d91fcafb3f4891e60
BLAKE2b-256 97994bacbd91d24a571c18ba42080c3b589c94e712e5a0633885651bf268ca4c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page