pdcomm-docs 명령 레퍼런스

pdcomm-docs는 PDComm 문서를 터미널에서 검색하고 읽는 프로그램입니다. AI 도구 연결은 AI 도구에서 PDComm 문서 사용하기에서 설명합니다. 이 페이지는 모든 명령과 옵션을 정리합니다.

pdcomm-docs search <검색어...> [--lang ko|en] [--product P] [--limit N] [--json]
pdcomm-docs get <URL 또는 ID> [--lang ko|en] [--json]
pdcomm-docs api <이름 또는 패턴> [--surface c|cpp|dotnet] [--product P] [--lang ko|en] [--limit N] [--json]
pdcomm-docs list [--lang ko|en] [--product P] [--depth 1|2] [--json]
pdcomm-docs serve [--root 폴더] [--port N] [--host 주소] [--open]
pdcomm-docs mcp
pdcomm-docs --help | --version

옵션은 --limit 3처럼 띄어 쓰거나 --limit=3처럼 붙여 씁니다. -- 뒤의 인수는 옵션이 아니라 검색어로 처리합니다. 명령에 맞지 않는 옵션을 쓰면 --port does not apply to search처럼 알려 주고 종료 코드 2로 끝납니다.

공통 옵션

색인 선택

search, get, api, list, mcp는 검색 색인 파일 search-index.json을 읽습니다. 다음 순서로 처음 지정된 것을 씁니다.

--index <파일>: 색인 파일을 직접 지정합니다.
--remote <URL>: 색인을 내려받습니다. HTTPS 주소만 허용하며, 이 컴퓨터의 주소(localhost, 127.0.0.1)만 HTTP를 허용합니다. 운영체제의 curl을 사용합니다.
--root <폴더>: 그 폴더의 search-index.json을 씁니다. 파일이 없으면 다른 색인으로 넘어가지 않고 오류로 끝납니다.
환경 변수 PDCOMM_DOCS_INDEX의 파일
프로그램 옆 묶음의 ../site/search-index.json

언어

--lang ko 또는 --lang en으로 고릅니다. 지정하지 않으면 환경 변수 PDCOMM_DOCS_LANG을 따릅니다. 둘 다 없으면 search는 검색어에 한글이 있을 때 한국어, 없을 때 영어를 고릅니다. get은 URL의 언어, list는 한국어, api는 영어를 씁니다.

제품

--product에는 getting-started, secs-gem, modbus, mqtt, opc-ua, tools 중 하나를 씁니다.

JSON 출력

search, get, api, list에 --json을 지정하면 결과를 JSON으로 출력합니다. 오류가 나면 표준 출력에 {"error": …}를 쓰고 표준 오류에도 메시지를 씁니다.

search

관련도가 높은 절(section)부터 제목, URL, 본문 일부를 보여 줍니다. --limit의 기본값은 10이고 1~100을 받습니다. 한 페이지에서 최대 3개 절까지 보여 줍니다.

pdcomm-docs search 가상 시리얼 널 모뎀 --limit 3

1. 도구 빠른 시작  [tools]
   https://pdcomm.podosoft.io/docs/tools/quickstart/
   이 페이지에서는 5분 안에 가상 시리얼 포트 두 개를 널 모뎀(null modem) 케이블로 잇고 …

2. 가상 시리얼 포트의 개념 › 모뎀 신호와 흐름 제어  [tools]
   https://pdcomm.podosoft.io/docs/tools/background/virtual-serial/#모뎀-신호와-흐름-제어
   포트는 RTS와 DTR을 출력하고 CTS, DSR, DCD, RI를 입력으로 봅니다. …

3 of 38 results (ko docs)

결과가 없으면 No results for …를 출력하고 종료 코드 0으로 끝납니다.

get

페이지나 절을 Markdown으로 출력합니다. 인수는 검색 결과의 URL, 경로(/docs/tools/quickstart/, 오프라인 사본에서는 /tools/quickstart/), ID 중 하나입니다. URL 끝에 #앵커가 있으면 그 절과 하위 절만 출력합니다. 마지막 줄에 Source: <URL>을 씁니다.

pdcomm-docs get /docs/tools/quickstart/
pdcomm-docs get /docs/tools/quickstart/ --lang en
pdcomm-docs get "/docs/tools/guides/virtual-serial-cli/#명령"

--lang으로 다른 언어 판을 엽니다. 없는 절을 지정하면 그 페이지의 절 목록을 알려 주고 종료 코드 1로 끝납니다.

api

C, C++, .NET API 심볼을 이름이나 패턴으로 찾습니다. *와 ?를 패턴으로 씁니다. --surface로 c, cpp, dotnet 중 하나로 좁힙니다. --limit의 기본값은 20이고 1~500을 받습니다.

pdcomm-docs api pdcomm_modbus_logging_configure
pdcomm-docs api 'pdcomm_modbus_logging_*' --surface c

일치하는 심볼이 3개 이하면 시그니처, 설명, 매개변수, 반환값, 선언 위치, 레퍼런스 URL을 모두 보여 줍니다. 더 많으면 한 줄에 하나씩 ID와 요약만 보여 줍니다.

pdcomm_modbus_logging_configure  (c function, modbus)

    int32_t pdcomm_modbus_logging_configure(const uint8_t *input, size_t size)

Library-local logging control; optional asynchronous JSONL, default off.
…
Id: c:pdcomm_modbus_logging_configure
Reference: https://pdcomm.podosoft.io/docs/en/modbus/reference/c/pdcomm_modbus_logging_configure/

일치하는 심볼이 없으면 종료 코드 1로 끝납니다. API 설명은 기본으로 영어입니다. 한국어 번역이 최신일 때만 --lang ko로 한국어를 보여 줍니다.

list

제품별 페이지를 사이드바 순서로 보여 줍니다. --depth 1은 페이지만, 기본값 --depth 2는 절과 앵커까지 보여 줍니다. 표준 오류에 색인을 만든 시각(Index built …)을 씁니다.

pdcomm-docs list --product tools --depth 1

serve

오프라인 문서 사이트를 이 컴퓨터의 웹 서버로 엽니다. 브라우저 검색이 동작하려면 파일을 직접 열지 않고 웹 서버로 열어야 합니다.

옵션	기본값	설명
`--root <폴더>`	프로그램 옆 묶음의 `../site`	제공할 사이트 폴더
`--port <N>`	`8787`	`0`이면 비어 있는 포트를 고릅니다.
`--host <주소>`	`127.0.0.1`	수신 대기 주소
`--open`	끔	기본 브라우저로 엽니다.

pdcomm-docs serve --port 0

Serving /opt/pdcomm-docs/site at http://127.0.0.1:59748/  (press Ctrl+C to stop)

없는 경로는 404 페이지로 응답하고, 사이트 폴더 밖을 가리키는 경로는 거부합니다. Ctrl+C로 끝냅니다.

mcp

MCP 서버로 실행합니다. 표준 입출력으로 줄 단위 JSON-RPC를 주고받으며 AI 도구가 실행합니다. 도구는 docs_search, docs_get_page, docs_api_lookup, docs_list_sections입니다. 연결 방법은 AI 도구에서 PDComm 문서 사용하기를 참고합니다.

종료 코드

코드	의미
`0`	성공했습니다. 검색 결과가 없는 경우도 포함합니다.
`1`	색인을 찾지 못했거나, 페이지·절·API 심볼이 없거나, 옵션 값이 범위를 벗어났거나, 서버를 시작하지 못했습니다.
`2`	명령이나 옵션 이름이 잘못되었습니다. 표준 오류에 사용법을 씁니다.

오류 메시지

메시지	해결
`no search index found (tried: …)`	색인 위치를 찾지 못했습니다. `--index`, `--root`, `PDCOMM_DOCS_INDEX` 중 하나로 지정합니다.
`unknown language "fr"; available: ko, en`	`--lang`에 `ko` 또는 `en`을 씁니다.
`no ko page matches "…"; search first or list the sections`	경로를 확인하거나 `search`, `list`로 찾습니다.
`… has no section #…; sections: …`	출력된 절 이름 중 하나를 씁니다.
`cannot use … as the site root: …`	`serve --root`의 폴더를 확인합니다.
`--limit must be a number in range, got "0"`	범위 안의 숫자를 씁니다.