https://github.com/kvokov/git-holmesian-story

🕵️‍♂️ A shell script that creates a Sherlock Holmes detective story told through Git commits and TypeScript diffs.
https://github.com/kvokov/git-holmesian-story

code-art commit-history creative-coding git shell sherlock-holmes storytelling typescript

Last synced: 3 months ago
JSON representation

🕵️‍♂️ A shell script that creates a Sherlock Holmes detective story told through Git commits and TypeScript diffs.

• Host: GitHub
• URL: https://github.com/kvokov/git-holmesian-story
• Owner: kvokov
• License: other
• Created: 2025-07-14T13:34:27.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2025-07-15T10:00:06.000Z (3 months ago)
• Last Synced: 2025-07-15T22:48:52.530Z (3 months ago)
• Topics: code-art, commit-history, creative-coding, git, shell, sherlock-holmes, storytelling, typescript
• Language: Shell
• Homepage:
• Size: 21 MB
• Stars: 4
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Git Sherlock Holmes Story Generator

[![License: 🍺 Beerware](https://img.shields.io/badge/license-🍺%20Beerware-yellow.svg?style=flat)](LICENSE)

[![GitHub Stars](https://img.shields.io/github/stars/kvokov/git-holmesian-story.svg?style=social)](https://github.com/kvokov/git-holmesian-story/stargazers)

[![GitHub Forks](https://img.shields.io/github/forks/kvokov/git-holmesian-story.svg?style=social)](https://github.com/kvokov/git-holmesian-story/network)

Turn a shell script into a **Sherlock Holmes detective tale** told *entirely* through Git commits.

---

## Quick start

```bash

git clone https://github.com/kvokov/git-holmesian-story

cd git-holmesian-story

chmod +x create_mystery_repo.sh

./create_mystery_repo.sh         # creates ./the-mystery-of-the-missing-semicolon

cd the-mystery-of-the-missing-semicolon

git log --reverse -p             # enjoy the story

```



  



---

## What you get

- **Ten canonical commits** that read like a short Conan-Doyle adventure.

- **TypeScript source** whose diffs advance the plot.

- **Zero** dependencies beyond standard **Git** and a **POSIX-compatible sh**.

- A sleek starting point for your own commit-driven narratives.

---

## How it works

`create_mystery_repo.sh` bootstraps a nested repository named **the-mystery-of-the-missing-semicolon**, timestamps each commit for natural ordering, and fills the history with code plus Holmesian prose. The outer repo is just the launcher, the inner repo is the story.

---

## Contributing

- Pull requests for new mysteries, tweaks, or README polish are welcome.

- Run `shellcheck create_mystery_repo.sh` before submitting.

---

## License

Released under the *Beerware* License - see [LICENSE](LICENSE) for details.