doks
0.9.3
문서가 온통 (Github, Google Drive 등)에 퍼져 있고 중앙 집중식 검색 도구를 원한다면 doks 귀하를위한 것입니다.
Dock는 여러 소스 (Github, Google Drive 등)에서 오는 문서를 검색 엔진으로 집계하는 CLI 도구입니다 (Lucene은 기본적으로 최소 로컬 설정에 사용되지만 Elasticsearch를 대신 사용할 수 있음).
설치 절차는 Docs/Install.md에서 찾을 수 있습니다.
문서는 문서 폴더에서 찾을 수 있습니다.
doks 에서 사용할 구성 파일을 선택합니다 (기본적으로 : $HOME/.doks/config/default.yml ) :
❯ export DOKS_CONFIG_FILE=docs/examples/config/simple.yml 여기에서 Docs/examples/config/simple.yml의 간단한 구성 파일을 사용하고 있습니다. 실제로이 내보내기가 필요하지 않으므로 구성을 기본 예상 경로 $HOME/.doks/config/default.yml 에 넣어야합니다.
다음 단계는 구성 파일에 참조 된 문서를 검색 할 수 있도록하는 것입니다.
❯ doks index
14:23:58 INFO - [wlezzar/jtab] cloning into ' /tmp/doks1910419821411559250 '
14:24:00 INFO - [wlezzar/jtab] 1 documents found !
14:24:00 INFO - [wlezzar/doks] cloning into ' /tmp/doks8654245137262434689 '
14:24:02 INFO - [wlezzar/doks] 0 documents found !
14:24:02 INFO - [adevinta/zoe] cloning into ' /tmp/doks756581970042346717 '
14:24:04 INFO - [adevinta/zoe] 36 documents found !검색 쿼리 수행 :
❯ doks search ' aws kafka ' | jq ' . '결과는 JSON에 있으며 다음과 같습니다.
[
{
"link" : " https://github.com/adevinta/zoe/blob/master/docs/advanced/runners/lambda.md " ,
"score" : 3.4977975 ,
"matches" : {
"content" : [
" # Lambda runner nn The lambda runner triggers lambda functions to read / produce to the <B>Kafka</B> " ,
" using CloudFormation (an S3 bucket, <B>AWS</B> roles, etc.). For more details on the resources deployed " ,
" into <B>AWS</B> and registering the lambda within <B>AWS</B>. Zoe jar path needs to be set and must point to a valid zoe "
]
}
},
...
]JTAB을 사용하여 JSON 결과를 테이블로 인쇄 할 수도 있습니다.
❯ doks search ' documentation search ' | jtab | less -S
┌────────────────────────────────────────────────────────────────────────────────┬───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬────────────┐
│ link │ matches │ score │
├────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼────────────┤
│ https://github.com/wlezzar/doks/blob/master/README.md │ content: │ 6.044318 │
│ │ - " <B>documents</B> coming from multiple sources (github, google drive, etc.) into a <B>search</B> engine (Lucene " │ │
│ │ - " - [adevinta/zoe] 36 <B>documents</B> found!n ` ` ` nn Make a < B > search < /B > query: nn ` ` ` bashn❯ doks <B>search</B> 'aws kafka' | jq " │ │
│ │ - " # DoksnnIf you have <B>documentation</B> spread all over the place (github, google drive, etc.) and you " │ │
├────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┼────────────┤
│ https://github.com/adevinta/zoe/blob/master/docs/basics/consume.md │ content: │ 3.2647414 │
│ │ - " will discard the message or not.nnThis feature can be used to perform <B>searches</B> into Kafka topics. It is one " │ │
│ │ - " ` ) and parallel execution ( ` --jobs 20 ` to spin up 20 pods), we can perform expensive < B > searches < /B > " │ │
│ │ - " execution in the advanced section of the < B > documentation < /B > . nn Filters are enabled with the ` --filter ` option " │ │
└────────────────────────────────────────────────────────────────────────────────┴───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴────────────┘Dock는 또한 CLI Haters를위한 UI 모드를 가지고 있습니다.)
❯ doks serve
23:16:10 INFO - listening on port: 8888
이제 http : // localhost : 8888에서 브라우저를 열 수 있습니다.
Twoks는 초기 단계에 있습니다. 버그가 예상되어야합니다;). 어떤 사람들이 만나거나 도움이 필요한 경우, Github 문제를 열어 주시기 바랍니다.
