# tm-cli 사용설명서

> 작업·스프린트·관리업무·리포트 등 **자세한 사용법은 앱에서 `tm guide`** 로 보세요.
> 영어판: [README.en.md](README.en.md)

**TM** 은 하루 근무를 **이벤트 로그**(append-only)로 기록하고, 상태·타임라인·리포트를 매번 거기서 파생하는 터미널 앱입니다.

- `tm` → **대시보드(TUI)** 가 열립니다.
- `tm <명령>` → **단발 실행** (예: `tm status`, `tm report`).
- 모든 시간은 **KST** 기준: **09:00~18:00 정규**, 이후는 **초과근무**.

---

## 목차

1. [설치와 초기화](#1-설치와-초기화)
2. [대시보드](#2-대시보드)
3. [자세한 사용법 — `tm guide`](#3-자세한-사용법--tm-guide)

---

## 1. 설치와 초기화

**필요 사항**: Node.js 18 이상.

```bash
npm i -g @seonsy44/tm-cli
```

설치 후 **처음 `tm` 을 실행하면 설정 마법사가 자동으로** 뜹니다 — 언어·이름·근무시간·리포트 설정을 차례로 물은 뒤 대시보드로 들어갑니다.

- 설정을 다시 하려면: `tm setup`
- **`tm init`** — `~/.tm` 에 설정·데이터 폴더를 만듭니다(기본값). 현재 폴더에 `config/`+`data/` 가 있으면 자동으로 가져옵니다.
- 데이터는 `~/.tm` 에 저장됩니다. `tm where` 로 경로 확인, `TM_DIR=<경로>` 또는 `tm --dir <경로>` 로 다른 위치에 격리할 수 있습니다.

---

## 2. 대시보드

`tm` 만 입력하면 대시보드가 열립니다.

```
╭────────────────────────────────────────────────────╮
│ TM v0.1.0                    16:31(wed) · 2026-07-08 │   >> 좌: 이름·버전 / 우: 시각(요일)·날짜
│ ────────────────────────────────────────────────── │
│ > 로그인 화면 리팩터링              15:27~ · 1h 4m   │   >> 지금 진행 중인 활동 + 시작시각·경과
│   JOB web-2026                                      │   >> 스프린트면 연결된 작업 코드
│ ────────────────────────────────────────────────── │
│ 09:00   기획 검토                            2h 4m   │  ┐
│ 11:04   API 설계                              20m    │  │  오늘의 타임라인
│ 11:40   점심                                   1h    │  │  (진행 중 줄은 앞에 > 표시)
│ 15:27 > 로그인 화면 리팩터링                 1h 4m   │  ┘
│ ────────────────────────────────────────────────── │
│ 6h 31m / 8h · over 0m                               │   >> 정규 근무 / 가능시간 · 초과근무
╰────────────────────────────────────────────────────╯
  · 로그인 화면 리팩터링                                   >> 활성 스프린트 목록
  + new sprint                                             >> 새 스프린트 등록
  + start admin task                                       >> 회의 등 관리업무 시작
  ──────────────
  job · report · timeoff · refresh · config · clock out    >> 하위 메뉴 / 퇴근
```

**조작키**

| 키 | 동작 |
|----|------|
| `↑` / `↓` | 항목 이동 |
| `→` | 선택 (엔터 아님) |
| `←` | 뒤로 / 대시보드 종료 |

**마커·색**: `·` 항목(포커스는 골드), `>` 실행 중(선택 불가), `+` 새로 추가. 색은 회색/흰색 + 골드 강조, 이모지는 쓰지 않습니다.

---

## 3. 자세한 사용법 — `tm guide`

작업(Job)·스프린트(Sprint)·관리업무(Admin task)·리포트(Report) 등 **전체 사용법은 앱 안의 온보딩 가이드**에 담겨 있습니다.

```bash
tm guide            # 인터랙티브 가이드 (섹션을 → 로 열고 ← 로 복귀)
tm guide --lang en  # 영어로 보기
```

가이드 언어는 설정 언어(`tm config` → 사용자 → 언어)를 따릅니다.