Skip to content

QUICK_START.md

Latest commit

 

History

History
266 lines (197 loc) · 5.57 KB

QUICK_START.md

File metadata and controls

266 lines (197 loc) · 5.57 KB
Raw

Quick Start Guide

For You (Testing Right Now)

1. Test Locally (2 minutes)

Linux/macOS/WSL:

# Make executable
chmod +x install.sh test-local.sh

# Run test
bash test-local.sh

# If successful, reload shell
source ~/.bashrc  # or source ~/.zshrc

Windows PowerShell:

# Run installer
. .\install.ps1

# Reload profile
. $PROFILE

2. Try the Commands

# See all commands
flash

# Bootstrap once (when you have good WiFi)
flash bootstrap-ml

# Create test ML project
flash ml test-ai-project
cd test-ai-project

# Check it works
uv run python -c "import torch; print('Torch version:', torch.__version__)"

3. Push to GitHub

# Initialize git
git init
git add .
git commit -m "Initial release: flash-pkg v1.0"

# Create repo on GitHub (name: flash-pkg)
# Then:
git remote add origin https://github.com/Yogesh1290/flash-pkg.git
git branch -M main
git push -u origin main

4. Test Public Install

Linux/macOS/WSL:

# Test the curl command
curl -sSL https://raw.githubusercontent.com/Yogesh1290/flash-pkg/main/install.sh | bash

Windows PowerShell:

# Test the PowerShell command
irm https://raw.githubusercontent.com/Yogesh1290/flash-pkg/main/install.ps1 | iex

Windows CMD:

powershell -Command "irm https://raw.githubusercontent.com/Yogesh1290/flash-pkg/main/install.ps1 | iex"

For Your Existing Projects

Python/ML Project with requirements.txt

# Your project
cd my-ai-project
cat requirements.txt
# torch==2.5.0
# paddleocr==2.8.1
# modelscope==1.20.0
# ... 50+ more deps

# Old way (45-90 minutes)
pip install -r requirements.txt  # ☕☕☕

# New way with flash-pkg
flash bootstrap-ml  # Once, 2-4 min
uv venv
uv pip install -r requirements.txt  # ⚡ 15 seconds!

JavaScript/React Project with package.json

# Your project
cd my-react-app
cat package.json
# react, react-dom, vite, typescript
# ... 100+ deps

# Old way (5-15 minutes)
npm install  # ☕☕

# New way with flash-pkg
flash bootstrap-mern  # Once, 2-4 min
bun install  # ⚡ 30 seconds!

Every Time After Bootstrap

cd my-ai-project
uv venv
uv pip install -r requirements.txt  # Always <30 seconds
uv run python main.py

Real-Life Usage Timeline

Day 1 (Setup Day)

# Morning (10 min total)
curl install.sh | bash          # 30 sec
source ~/.bashrc                # instant
flash bootstrap-ml              # 3 min (on cafe WiFi)

# Afternoon (work on 3 projects)
flash ml project1               # 20 sec
flash ml project2               # 18 sec
flash ml project3               # 22 sec

# Total time: 11 minutes
# Old way: 135 minutes (45 min × 3)
# Time saved: 124 minutes

Day 2-365 (Every Day After)

flash ml new-project            # 15-25 sec
# Always instant. Forever.

Sharing with Team

Your teammate needs:

# 1. Install (30 sec)
curl -sSL https://raw.githubusercontent.com/Yogesh1290/flash-pkg/main/install.sh | bash

# 2. Bootstrap once (3 min)
flash bootstrap-ml

# 3. Clone your project
git clone your-repo
cd your-repo
uv pip install -r requirements.txt  # 20 sec

# Done!

Commands Cheat Sheet

# Setup (once)
flash bootstrap-ml              # CPU version
flash bootstrap-ml-gpu          # GPU version

# Create projects
flash ml <name>                 # Python ML project
flash mern <name>               # MERN app

# Enterprise
flash docker-ml <name>          # Docker template
flash enterprise-install        # Rollout guide
flash sbom                      # Security audit

# Help
flash                           # Show all commands

Troubleshooting

"flash: command not found"

source ~/.bashrc  # or ~/.zshrc

"uv: command not found"

export PATH="$HOME/.cargo/bin:$PATH"
source ~/.bashrc

Bootstrap is slow

# Check mirror
uv pip config get global.index-url

# Try different mirror
uv pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/

Windows users

  • WSL2: Full support (60s install due to filesystem)
  • PowerShell: Full support (v1.1.1+)
  • Git Bash: Use WSL2 instead

Next Steps

  1. ✅ Test locally
  2. ✅ Push to GitHub
  3. ✅ Bootstrap once
  4. ✅ Use on real project
  5. 📢 Share on Reddit/LinkedIn/Twitter
  6. ⭐ Get stars
  7. 🚀 Watch it grow

Success Metrics

After using flash-pkg, you should see:

  • New ML project setup: <30 seconds (was 45-90 min)
  • New MERN app: <10 seconds (was 5-15 min)
  • Team onboarding: <5 minutes (was 1-2 hours)
  • Monthly time saved: 15+ hours (per developer)

Share Your Results

Post your before/after times:

  • Reddit: r/Python, r/MachineLearning
  • Twitter: @mention me
  • LinkedIn: Tag #flashpkg

You built the gem. Now ship it! 🚀

Common Questions

Q: Why was my first install slow?
A: First time downloads packages (15 min normal). Every project after is <1 minute!

Q: Where are packages cached?
A: ~/.cache/uv (about 1 GB). Check size: du -sh ~/.cache/uv

Q: How to clean cache?
A: rm -rf ~/.cache/uv or uv cache clean

Q: Does it work in any IDE?
A: YES! VS Code, PyCharm, Jupyter - anywhere. Just use uv pip install.

📖 See FAQ.md for 20+ questions answered

Next: Read HOW_IT_WORKS.md to understand the magic, or SETUP.md to push to GitHub.