env-doctor quickstart — audit .env trong 5 phút

Mục tiêu

Audit file .env của dự án so với .env.example và sửa drift, trùng lặp, placeholder, secret rủi ro.

Điều kiện

• Đã cài Python 3.9+
• Dự án có file .env và .env.example

Các bước

1. Lấy env-doctor (clone một lần, ở đâu cũng được):

   git clone https://github.com/techdevfun/env-doctor.git
   cd env-doctor
   # Tuỳ chọn: để dùng lệnh từ mọi thư mục
   pip install -e .

   Copy
2. Từ thư mục DỰ ÁN của bạn (không phải thư mục env-doctor), chạy check với file của dự án:

   cd /path/to/your-project
   python -m env_doctor check --env .env --example .env.example

   Copy

   Trỏ --env / --example tới file của dự án (đường dẫn tuyệt đối hoặc tương đối theo dự án). Đừng chạy với thư mục env-doctor.

3. Sửa drift bằng tay: thêm key thiếu vào .env.example dạng placeholder rỗng, và xóa key không còn dùng. env-doctor chưa tự sửa — cờ tự sửa đang nằm trong roadmap, chưa làm xong.
4. Gắn cờ biến không được code dùng tới (vẫn từ thư mục dự án):

   python -m env_doctor check --env .env --example .env.example --scan .

   Copy

Output mong đợi (ví dụ drift)

[ERROR] duplicate-key: Duplicate key 'DATABASE_URL' (line 3)
[ERROR] missing-in-env: 'NEW_API_URL' is in .env.example but missing in .env
Summary: 2 error(s), 2 warning(s), 3 key(s).

Kiểm chứng

Chạy lại check. Bạn nên thấy Summary: 0 error(s). Exit code 0 nghĩa là không lỗi.

Sửa lỗi

• Không tìm thấy lệnh: kiểm tra python --version là 3.9+ và env-doctor đã được cài / có trong PYTHONPATH và bạn đang ở thư mục dự án.
• Chỉ có warning: warning không làm fail. Hãy xem xét, đừng xóa biến mù quáng.
• Secret bị lộ: env-doctor không sửa secret đã lộ — hãy xoay (rotate) secret ngay.