마크다운 헤더 및 링크 추출을 위한 mq CLI 도구 사용법

카테고리

프로그래밍/소프트웨어 개발

서브카테고리

개발 툴

대상자

• 중급~고급 개발자 (CLI 도구 사용, 마크다운 구조 이해 필요)
• LLM(대규모 언어 모델)과 협업하는 개발자 (문서 요약, 탐색 등에 활용)

핵심 요약

• mq CLI는 마크다운 문서의 헤더/링크만 추출하여 LLM과 협업 가능
• .h 선택자로 헤더 추출, s"- ${h}" 형식으로 링크 생성
• 추출된 목록을 목차 또는 LLM 입력 힌트로 활용 가능

섹션별 세부 요약

1. mq CLI 도구 개요

• mq는 jq와 유사한 CLI 도구로 마크다운 문서 구조 조작 가능
• LLM과 협업 시 전체 문서 대신 헤더/링크만 제공 가능
• zsh 환경에서 작동하는 명령 예시 제공

2. 헤더 추출 명령어 예시

• .h 선택자로 모든 헤더 선택
• let h = to_text()로 헤더 텍스트 추출
• s"- ${h}"로 파일 경로 포함 링크 생성
• 예시: mq '.h | let h = to_text() | s"- ${h}"' **/*.md

3. 출력 결과 및 활용 예시

• 출력 형식: - 헤더명
• 예시:

- Introduction

- Usage

• 목차 생성 또는 LLM 입력 힌트로 활용 가능

4. 설치 및 추가 자료

• 설치 방법:

- cargo install --git mq-cli

- brew install harehare/tap/mq

• 관련 링크: Docs, Playground

결론

• mq는 마크다운 문서의 구조 요소 추출을 간소화하여 LLM과의 협업 효율성 향상
• 필요 시 전문 문서 참고 (Docs, Playground 활용)