How to install?

If you wanna just downloading the pre-compiled binary (Recommended)

1- Go to Github Releases page and download your platforms file. 2- If you wanna download pre-compiled binary with cargo-binstall:

cargo install cargo-binstall # skip if already installed
cargo binstall checkpoint-ts # downloads the file for specific your platforms

If you wanna build from source

From crates.io:

cargo install checkpoint-ts

From GitHub:

git clone https://github.com/ErenayDev/checkpoint-ts.git
cd checkpoint-ts
cargo build --release

Platform specific downloads

Arch Linux(AUR)

From Source

Prebuilt binary not available at AUR yet

yay -S checkpoint

NixOS

Just a placeholder

RPM-Based

Just a placeholder

Debian-Based

Just a placeholder

Versions

How can I develop checkpoint.ts?

First, install a runtime. I choose Bun. If you ready, change the main commands in the below with your favourite runtime. Then run them in the root folder.

Install monorepo package stuffs

bun i

Install pre-commit hook

pip install pre-commit # or with uv
pre-commit install

Run the app

cargo run

How to release?

1. Bump the version in Cargo.toml according to Semantic Versioning.
2. Update Cargo.lock by building the project: cargo build
3. Ensure CHANGELOG.md is updated according to Keep a Changelog format. git-cliff recommended. (Run git-cliff > CHANGELOG.md Then edit Unreleased to next tag and add release date like others)
4. Commit and push the changes.
5. Create a new tag: git tag -s -a v[x.y.z] (signed)
6. Push the tag: git push --tags
7. Wait for Continuous Deployment workflow to finish.
8. Publish to crates.io: cargo publish
9. Update AUR package in PKGBUILDs repository:
   • Run update.sh checkpoint-ts [x.y.z]
   • Run aurpublish checkpoint-ts