AI작업 많이 하다보니까. 마크다운(.md) 파일이 자꾸 쌓이더라구요.그래서 TUI로에디터 만들어서 쓸만한 거 같아 공유드립니다. (오늘은 터미널 버전만 공유드리고, 다음에는 데스크톱에디터 버전으로 맥/윈도우/리눅스용 UI버전 공유할께요. 이건 아직 좀 더 개발해야해서)

Markdown 파일을 자주 열어보거나, README/메모를 터미널에서 관리하시는 분들께 소개해봅니다. (MIT 라이센스입니다. 무료고 수정해서 쓰셔도 됩니다)

제가 만든 `mdok-cli`는 `.md` 파일을 터미널에서 읽고, 편집하고, 바로 미리볼 수 있는 작은 TUI 에디터입니다. (마우스로 버튼클릭이나 스크롤 등이 됩니다)

이름은 Markdown OK의 줄임말입니다.

이런 식으로 씁니다 (노드랑 npm이 있어야해요)

npm install -g @daystar7777/mdok

mdok README.md       # 파일 열기

mdok                 # 마지막 세션 이어서 열기

mdok view README.md  # 터미널용 예쁜 출력

실행하면 왼쪽에는 파일/목차가 나오고,(mdok 좌측의 화살표를 누르면 나옵니다) 가운데 화면은 분할 편집·소스 편집·읽기 보기로 전환할 수 있습니다. 탭을 여러 개 열어둘 수도 있고, 종료 후 다시 실행하면 열린 탭과 커서 위치도 복원합니다.

분할 화면에서는 Markdown을 고치면서 오른쪽 미리보기가 바로 따라옵니다.

소스만 넓게 보고 편집할 수도 있습니다.

읽기만 할 때는 Markdown 렌더링 결과만 깔끔하게 볼 수 있습니다.

## 왼쪽 사이드바

화면 왼쪽 위의 `<` 버튼(터미널 폭에 따라 `[>]`로 보일 수 있음)을 누르면 사이드바가 열립니다. 여기에 최근에 열었던 파일, 현재 문서의 목차, 작업 폴더 안의 Markdown 파일 목록이 나옵니다.

파일을 여러 개 오갈 때나 긴 문서에서 목차를 눌러 이동할 때 쓰는 영역이고, 본문을 넓게 보고 싶을 때는 같은 버튼으로 다시 접을 수 있습니다. 키보드로는 `Ctrl+O` 다음 `b`를 누르면 됩니다.

## 기존 Markdown 도구와 조금 다른 점

Markdown을 편집할 때 미리보려고 브라우저를 따로 열거나, 문서를 다른 서비스에 붙여넣는 과정이 번거로워서 만들기 시작했습니다.

- 소스 편집과 실시간 미리보기

- 한국어/영어 UI, 한글·한자·이모지 폭 처리

- 탭, 최근 파일, 목차 사이드바, 세션 복원

- 찾기/바꾸기, Markdown 린트, 표 정리, HTML 내보내기

- 테마 5종과 줄번호, 기본 Vim 모드

- 저장 시 원자적 기록, Git 저장소에서는 자동 커밋/푸시/풀 보조

특히 터미널에서 한글이 들어간 문서를 편집할 때 커서가 한 칸씩 밀리는 일이 꽤 거슬렸는데, 표시 폭 기준으로 계산하도록 따로 처리했습니다.

## 읽기만 할 때는 더 단순하게

TUI를 띄우지 않고 Markdown을 터미널에서 보기 좋게 렌더링하는 `view` 명령도 넣었습니다.

mdok view README.md | less

파이프에 연결해서 쓰거나, SSH로 접속한 서버에서 README나 작업 메모를 확인할 때 편합니다.

## AI 기능은 BYOK 방식입니다

API 키를 프로그램에 넣어둔 방식이 아니라, 본인이 가진 API 키를 환경변수로 넣는 방식입니다.

export MDOK_API_KEY=sk-...

mdok ask README.md -q "이 문서 3줄로 요약해줘"

TUI 안에서도 열린 문서에 질문하거나 선택 영역을 AI로 고쳐쓰고, 변경 전후 diff를 확인한 뒤 적용할 수 있습니다. OpenAI 호환 API 주소와 모델을 설정할 수 있어서, 다른 호환 엔드포인트나 로컬 서버에도 연결할 수 있습니다.

다만 AI 기능은 문서가 외부 API로 전송되는 기능인 만큼, 민감한 문서에는 주의가 필요합니다. 앱에서 공용 키를 제공하는 방식은 아니고, 사용자가 직접 키와 전송 대상을 선택합니다.

## Git과 QR

Git 저장소 안에서 사용하면 저장 후 자동 커밋을 만들고, 별도 패널에서 push/pull/수동 commit을 할 수 있습니다. Git을 원하지 않으면 끌 수 있습니다.

- GitHub: https://github.com/daystar7777/mdok-cli

- npm: https://www.npmjs.com/package/@daystar7777/mdok

Node.js 22 이상이 필요합니다. MIT 라이선스이고, 아직 0.x대라 기능이나 UI는 계속 다듬고 있습니다.

터미널에서 Markdown을 많이 보시는 분들이라면 한 번 써보시고, 특히 키 조작이나 미리보기 쪽에서 불편한 점을 알려주시면 다음 버전에 반영해보겠습니다.