generated_project

A project generated from features.md using LLM.

Installation

pip install -e .

Features

✅ Epic: Xây dựng Dotfile Manager CLI Tool

---

📦 Feature 1: CLI Interface

• Tạo cấu trúc CLI
  • Tạo command group chính (dotman)
  • Thêm command init (tạo repo dotfiles)
  • Thêm command add <filepath>
  • Thêm command restore
  • Thêm command sync
  • Thêm command status (hiển thị files được quản lý)

---

📁 Feature 2: Quản lý dotfiles

• Tạo thư mục dotfile repo

  • Check tồn tại thư mục ~/.dotman, nếu chưa có thì tạo
  • Tạo file manifest.json để lưu metadata

• Thêm dotfile vào hệ thống

  • Copy hoặc symlink file gốc vào repo
  • Cập nhật manifest.json với thông tin file
  • Backup file gốc nếu cần

• Khôi phục dotfiles

  • Đọc manifest.json
  • Copy hoặc tạo symlink file về vị trí gốc

• Đồng bộ dotfiles (git)

  • Commit + push repo dotfiles lên Git
  • Pull + update khi restore trên máy khác

---

🔗 Feature 3: Symlink & OS Compatibility

• Tạo symlink an toàn
  • Kiểm tra OS (nt, posix)
  • Tạo symlink hoặc copy fallback nếu không hỗ trợ
  • Kiểm tra file đích có bị ghi đè không

---

📄 Feature 4: Metadata Tracking

• Tạo & quản lý manifest file
  • Cấu trúc JSON: { "files": [ { path, original_path, added_at } ] }
  • Hàm đọc/ghi JSON
  • Validate manifest consistency

---

🔍 Feature 5: Hiển thị trạng thái

• Command dotman status
  • Liệt kê các file đang được quản lý
  • So sánh hash (hoặc mtime) với file gốc
  • Highlight file bị thay đổi

---

🧪 Feature 6: Testing

• Viết unit tests
  • Test CLI commands (init, add, restore)
  • Test symlink logic
  • Test manifest file đọc/ghi

---

📚 Feature 7: Documentation

• Viết README

  • Hướng dẫn cài đặt
  • Cách dùng từng command
  • Ví dụ sync dotfiles giữa 2 máy

• Viết help trong CLI

  • Thêm --help cho mỗi command
  • Mô tả rõ từng argument

---

🌐 Feature 8: Public Release

• Đóng gói và phát hành
  • Build package (pip install .)
  • Push lên GitHub
  • Tạo release v1.0.0
  • Gắn tag, license, label open-source