@dicamo/flint-ai-bridge 0.0.0-stage → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,3 +1,88 @@
1
- # Temporary Holding Version
1
+ # FLiNT AI Bridge
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ FLiNT CMS와 내 PC에 설치된 Claude Code 또는 Codex를 연결하는 도구입니다.
4
+
5
+ Claude Code를 통한 AI 대화와 CMS 읽기 전용 조회를 지원합니다. Codex는 설치 상태 확인만 지원하며, 채팅 실행은 아직 지원하지 않습니다.
6
+
7
+ ## 준비 사항
8
+
9
+ - Node.js 22 이상
10
+ - Claude Code **2.1.285** 설치 및 구독 계정 로그인(현재 채팅 실행 검증 버전)
11
+ - FLiNT CMS 계정과 AI 어시스턴트 사용 권한
12
+ - 관리자가 안내한 CMS 주소와 서버 주소
13
+
14
+ 현재 macOS에서 사용을 확인했습니다. Windows와 Linux 지원은 준비 중입니다.
15
+
16
+ ## 처음 연결하기
17
+
18
+ ### 1. CMS 주소 등록
19
+
20
+ 아래 예시의 주소를 관리자가 안내한 값으로 바꿔 실행하세요.
21
+
22
+ ```sh
23
+ npx @dicamo/flint-ai-bridge@latest configure \
24
+ --id my-cms \
25
+ --server https://api.example.com \
26
+ --origin https://cms.example.com
27
+ ```
28
+
29
+ | 옵션 | 입력할 값 |
30
+ | --- | --- |
31
+ | `--id` | 이 연결을 구분할 이름. 영문 소문자·숫자·하이픈을 사용하세요. |
32
+ | `--server` | 관리자가 안내한 서버 주소 |
33
+ | `--origin` | 브라우저에서 접속하는 CMS 주소 |
34
+
35
+ 주소는 `https://`를 포함하고, `/device` 같은 화면 경로나 마지막 `/`는 제외하세요.
36
+ 주소를 변경할 때는 실행 중인 브리지를 먼저 종료하세요.
37
+
38
+ ### 2. 브리지 실행
39
+
40
+ ```sh
41
+ npx @dicamo/flint-ai-bridge@1.0.0 serve --enable-chat
42
+ ```
43
+
44
+ 연결하는 동안 터미널을 열어 두세요. macOS에서는 PC 승인 창으로 연결할 수 있으며, 터미널의 6자리 코드는 대체 연결 수단입니다.
45
+
46
+ ### 3. CMS에서 연결
47
+
48
+ 1. CMS에 로그인하고 우측 하단의 **Flint AI**를 엽니다.
49
+ 2. **이 PC에 연결**을 누르고, PC 승인 창에 표시된 CMS 주소를 확인한 뒤 **허용**합니다. macOS 외 환경이나 승인 창을 사용할 수 없으면 **코드로 연결**을 사용합니다.
50
+ 3. 브라우저가 로컬 네트워크 접근 권한을 요청하면 허용합니다.
51
+ 4. 연결 및 사용자 인증 완료 메시지를 확인합니다.
52
+
53
+ 코드는 5분간 유효합니다. 만료되면 브리지 터미널에 `pair`를 입력해 새 코드를 발급하세요.
54
+
55
+ ## CMS 데이터 질문하기
56
+
57
+ 위의 `serve --enable-chat` 명령으로 실행하면 CMS에서 채팅을 사용할 수 있습니다. 이 옵션을 생략하면 연결 및 계정 인증만 활성화됩니다.
58
+
59
+ 회사·매장·단말·미디어·씬·사용자·로그인 이력·자동화·앱·휴무일·3D 맵과 대시보드/미디어 재생 통계를 질문할 수 있습니다. 예를 들어 “최근 등록된 단말 10대”, “오프라인 단말은 총 몇 대?”, “이번 주 미디어 재생 통계”를 물어보세요.
60
+
61
+ 각 조회에는 본인의 메뉴 claim과 회사·매장 접근 범위, 서버의 데이터 접근 정책이 적용됩니다. owner는 전체 조회 권한을 가집니다. 데이터 변경이나 원격 명령 실행은 지원하지 않습니다. 이력·설치 앱 등의 하위 데이터는 먼저 대상 ID를 확인하고 조회합니다. 통계는 서버에 해당 조회 함수가 설치되어 있어야 합니다.
62
+
63
+ ## 다시 연결하거나 종료하기
64
+
65
+ 자동 재연결과 브라우저 연결 정보 저장은 하지 않습니다. 연결이 끊기면 브리지를 실행하고 CMS에서 **다시 찾기 → 이 PC에 연결**을 눌러 다시 승인하세요. 승인 창은 60초 후 만료됩니다.
66
+
67
+ 브리지를 종료하려면 터미널에서 `Ctrl+C`를 누르세요.
68
+
69
+ 현재 CMS와의 연결을 해제하려면 Flint AI의 **페어링 해제**를 누르세요.
70
+ 이 PC의 모든 CMS 연결을 해제하려면 다음 명령을 실행하세요.
71
+
72
+ ```sh
73
+ npx @dicamo/flint-ai-bridge@latest unpair
74
+ ```
75
+
76
+ ## 연결이 안 될 때
77
+
78
+ - **Flint AI 버튼이 보이지 않아요:** CMS 관리자에게 AI 어시스턴트 사용 권한을 확인해 주세요.
79
+ - **브리지를 찾지 못해요:** 브리지 터미널이 실행 중인지, 브라우저에서 로컬 네트워크 접근을 허용했는지 확인하세요.
80
+ - **코드가 만료되었어요:** 브리지 터미널에 `pair`를 입력하세요. 여러 번 잘못 입력해 잠겼다면 60초 뒤 다시 발급하세요.
81
+ - **주소가 등록되지 않았다고 나와요:** 브리지를 종료하고 CMS 주소와 서버 주소를 다시 등록하세요.
82
+ - **로그인 또는 권한을 확인할 수 없어요:** CMS에 다시 로그인하세요. 계속되면 관리자에게 문의해 주세요.
83
+
84
+ 명령어 도움말:
85
+
86
+ ```sh
87
+ npx @dicamo/flint-ai-bridge@latest --help
88
+ ```
@@ -0,0 +1,14 @@
1
+ // src/protocol.ts
2
+ var PROTOCOL_VERSION = 1;
3
+ var PORTS = Array.from({ length: 10 }, (_, i) => 47820 + i);
4
+ var AI_CLAIM = "enable:ai.assistant";
5
+ var MAX_MESSAGE_BYTES = 256 * 1024;
6
+ var RESOURCES = ["companies", "devices", "studio", "media", "dashboard", "users", "users.login_history", "automations", "holidays", "app_store", "alterra", "media_log"];
7
+
8
+ export {
9
+ PROTOCOL_VERSION,
10
+ PORTS,
11
+ AI_CLAIM,
12
+ MAX_MESSAGE_BYTES,
13
+ RESOURCES
14
+ };
package/dist/cli.d.ts ADDED
@@ -0,0 +1 @@
1
+ #!/usr/bin/env node