Skip to main content

Never forget the engineering stories behind your code

Project description

QuickSnap

Git remembers what changed. QuickSnap remembers why.

Your second brain for software engineering. Capture, search, and recall your engineering decisions for interviews, performance reviews, and knowledge sharing.


What Is This?

Every developer has solved hard problems. Race conditions. Performance bottlenecks. Authentication redesigns. System migrations.

Six months later, you can't remember the details. The code is there. The commits are there. But the reasoning — why you chose Redis over PostgreSQL, what alternatives you rejected, what tradeoffs you accepted — that's gone.

QuickSnap captures those details right after you finish a task, while your thinking is still fresh. It turns your daily coding into a searchable archive of interview-ready stories.


How It Works

You finish coding
       ↓
git commit
       ↓
QuickSnap captures automatically
       ↓
Story saved to .snapshots/
       ↓
Months later → search and recall everything

Without QuickSnap:

  • You commit code
  • You forget the reasoning
  • Interview comes → blank mind

With QuickSnap:

  • You commit code
  • Story auto-captured with git context
  • Interview comes → full story ready

The Two Products

QuickSnap has two interfaces that share the same core:

1. CLI (Primary)

A terminal tool. Install with pip, run from any project.

pip install -e .
quicksnap capture        # Interactive — answers questions
quicksnap capture -n     # Automatic — fills from git
quicksnap list           # Browse all stories
quicksnap search redis   # Search by keyword
quicksnap search-natural caching  # Natural language search
quicksnap star auth-fix  # STAR format for interviews
quicksnap bullets auth-fix  # Resume bullet points
quicksnap practice       # Random interview questions
quicksnap interview      # Interview practice with self-scoring
quicksnap generate auth-fix linkedin  # Generate LinkedIn post
quicksnap generate auth-fix blog      # Generate blog draft
quicksnap export-portfolio  # Full engineering portfolio
quicksnap tag auth-fix Backend,Performance  # Add tags
quicksnap untag auth-fix Backend  # Remove tags
quicksnap tags-list      # List all tags
quicksnap sync-export    # Export to zip for cross-device sync
quicksnap sync-import    # Import from zip

Commands Reference

Command What It Does Example
capture Create a new story quicksnap capture
capture -n Auto-capture from git quicksnap capture -n
list Show all stories quicksnap list
list --tag Backend Filter by tag quicksnap list --tag Performance
show <slug> View a story quicksnap show auth-cache
search <query> Search stories quicksnap search redis
search-natural <query> Natural language search quicksnap search-natural caching
star <slug> STAR format quicksnap star auth-cache
bullets <slug> Resume bullets quicksnap bullets auth-cache
practice Interview practice quicksnap practice
interview Interview with self-scoring quicksnap interview --tag Backend
generate <slug> <format> Generate content quicksnap generate auth-fix linkedin
tag <slug> <tags> Add tags quicksnap tag auth-fix Backend,Redis
untag <slug> <tags> Remove tags quicksnap untag auth-fix Backend
tags-list List all tags quicksnap tags-list
export-portfolio Full portfolio quicksnap export-portfolio
sync-export Export to zip quicksnap sync-export
sync-import Import from zip quicksnap sync-import
delete-cmd <slug> Delete a story quicksnap delete-cmd auth-cache
init Setup in a repo quicksnap init

Configuration

Create .quicksnap.yaml in your project root:

version: "0.2.0"
ai_mode: auto          # manual | auto | local | openai | anthropic | gemini

VS Code settings (in settings.json):

{
  "quicksnap.cliPath": "quicksnap",
  "quicksnap.notifyAfterCommit": true
}

Development

CLI

cd D:\quicksnap
pip install -e .            # Install in dev mode
quicksnap --help        # Test
quicksnap capture -n    # Test auto-capture

Testing

python -m pytest tests/ -v

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

quicksnap-0.2.4.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

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

quicksnap-0.2.4-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

File details

Details for the file quicksnap-0.2.4.tar.gz.

File metadata

  • Download URL: quicksnap-0.2.4.tar.gz
  • Upload date:
  • Size: 27.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for quicksnap-0.2.4.tar.gz
Algorithm Hash digest
SHA256 18580c886158ab5fd6d5d455cfa97d8c05e27395e23af435f7d2302bb1319618
MD5 3089da0f1169baaac2caa79afa507fd2
BLAKE2b-256 78bc1383a754c8e3faa3fdc0f86cc246810945da2039c8441682e66a3d826fba

See more details on using hashes here.

File details

Details for the file quicksnap-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: quicksnap-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 24.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for quicksnap-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e7e7316e8cc697bf3ce4721abca4cca49ce86854c02501bcb0a8c46a12f5da25
MD5 074ec768ab33ace7116887fed6f42ee7
BLAKE2b-256 2324e39c87e2d1b53f0825bb92231df2a26570f33cf8754a20734755862771a0

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