aranea-sdk-cli 0.3.1 → 0.3.2
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 +96 -4
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,42 @@
|
|
|
4
4
|
|
|
5
5
|
AraneaSDK CLI - ESP32 IoTデバイス開発支援ツール
|
|
6
6
|
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 🤖 AIエージェント向けガイド
|
|
10
|
+
|
|
11
|
+
> **AIエージェント (Claude, Codex, etc.) がAraneaSDK関連タスクを実行する際は、このCLIを使用してください。**
|
|
12
|
+
|
|
13
|
+
### ナレッジ追加 (ローカルファイルではなくCLI経由で)
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# ❌ ローカルファイル作成ではなく
|
|
17
|
+
# ✅ CLIでナレッジベースに追加
|
|
18
|
+
aranea-sdk knowledge add \
|
|
19
|
+
--title "ESP32 HTTPSタイムアウト設定" \
|
|
20
|
+
--category tip \
|
|
21
|
+
--content "ESP32でHTTPS接続する場合、最低15秒のタイムアウトが必要。初回SSL handshakeは特に時間がかかる。" \
|
|
22
|
+
--keywords "esp32,https,timeout,ssl"
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Metatronへの質問 (AIアシスタント連携)
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# AraneaSDK専門AIに質問
|
|
29
|
+
aranea-sdk metatron ask "ESP32のHTTPSタイムアウトのベストプラクティスは?"
|
|
30
|
+
|
|
31
|
+
# 対話モード
|
|
32
|
+
aranea-sdk metatron chat
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### 典型的なワークフロー
|
|
36
|
+
|
|
37
|
+
1. **問題解決時**: `metatron ask "問題の説明"` で既存ナレッジを確認
|
|
38
|
+
2. **新知見発見時**: `knowledge add` でナレッジベースに追加
|
|
39
|
+
3. **デバイス登録時**: `register --dry-run` で検証後、実登録
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
7
43
|
## 概要
|
|
8
44
|
|
|
9
45
|
AraneaSDK CLIは、AraneaSDK対応ESP32デバイスの開発・テスト・登録を支援するコマンドラインツールです。
|
|
@@ -39,12 +75,13 @@ aranea-sdk metatron ask "State Reportの送信方法は?"
|
|
|
39
75
|
|---------|------|------|
|
|
40
76
|
| `test` | 接続・認証テスト | 不要 |
|
|
41
77
|
| `register` | デバイス登録 | 不要(テストテナント) |
|
|
42
|
-
| `schema` |
|
|
78
|
+
| `schema` | スキーマ取得・検証・プッシュ | push/promote時必要 |
|
|
43
79
|
| `validate` | Type名検証 | 不要 |
|
|
44
80
|
| `simulate` | 状態レポートシミュレーション | 不要 |
|
|
45
81
|
| `mqtt` | コマンド送信・ACKモニタリング | **必要** |
|
|
46
82
|
| `knowledge` | ナレッジベース管理 | **必要** |
|
|
47
83
|
| `metatron` | AI対話アシスタント | **必要** |
|
|
84
|
+
| `auth` | 認証トークン管理 | - |
|
|
48
85
|
|
|
49
86
|
---
|
|
50
87
|
|
|
@@ -166,11 +203,27 @@ aranea-sdk schema validate --file state.json --type aranea_ar-is04a
|
|
|
166
203
|
| `list` | ✅ 実装済み | 登録済みスキーマ一覧 |
|
|
167
204
|
| `get` | ✅ 実装済み | スキーマ詳細取得 |
|
|
168
205
|
| `validate` | ✅ 実装済み | State Report 検証 |
|
|
169
|
-
| `
|
|
170
|
-
| `push` |
|
|
171
|
-
| `promote` |
|
|
206
|
+
| `validate-schema` | ✅ 実装済み | スキーマ定義の静的検証 |
|
|
207
|
+
| `push` | ✅ 実装済み | 開発環境へプッシュ (認証必要) |
|
|
208
|
+
| `promote` | ✅ 実装済み | 本番環境へ昇格 (認証必要、確認ステップあり) |
|
|
209
|
+
| `info` | ✅ 実装済み | スキーマ詳細情報・リビジョン履歴 |
|
|
172
210
|
| `rollback` | 🔜 計画中 | バージョンロールバック |
|
|
173
211
|
|
|
212
|
+
### 環境切替 (v0.3.1)
|
|
213
|
+
|
|
214
|
+
すべてのschemaサブコマンドで `--endpoint` オプションが使用可能です:
|
|
215
|
+
|
|
216
|
+
```bash
|
|
217
|
+
# デフォルト: staging
|
|
218
|
+
aranea-sdk schema list
|
|
219
|
+
|
|
220
|
+
# 明示的にproduction指定
|
|
221
|
+
aranea-sdk schema list --endpoint production
|
|
222
|
+
|
|
223
|
+
# 環境変数でも指定可能
|
|
224
|
+
ARANEA_ENV=production aranea-sdk schema list
|
|
225
|
+
```
|
|
226
|
+
|
|
174
227
|
---
|
|
175
228
|
|
|
176
229
|
## validate - Type名検証
|
|
@@ -339,6 +392,45 @@ aranea-sdk metatron examples
|
|
|
339
392
|
|
|
340
393
|
---
|
|
341
394
|
|
|
395
|
+
## auth - 認証管理 (v0.3.1)
|
|
396
|
+
|
|
397
|
+
Firebase Auth IDトークンを管理します。トークンは `~/.aranea-sdk/credentials.json` に保存されます。
|
|
398
|
+
|
|
399
|
+
### 使用例
|
|
400
|
+
|
|
401
|
+
```bash
|
|
402
|
+
# ログイン (対話式)
|
|
403
|
+
aranea-sdk auth login
|
|
404
|
+
|
|
405
|
+
# メールアドレス指定でログイン
|
|
406
|
+
aranea-sdk auth login --email dev@example.com
|
|
407
|
+
|
|
408
|
+
# トークン情報表示
|
|
409
|
+
aranea-sdk auth token
|
|
410
|
+
|
|
411
|
+
# トークンのみ出力 (スクリプト用)
|
|
412
|
+
aranea-sdk auth token --raw
|
|
413
|
+
|
|
414
|
+
# トークン更新 (1時間で期限切れ)
|
|
415
|
+
aranea-sdk auth refresh
|
|
416
|
+
|
|
417
|
+
# ログアウト
|
|
418
|
+
aranea-sdk auth logout
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### トークンライフサイクル
|
|
422
|
+
|
|
423
|
+
- IDトークンは **1時間** で期限切れ
|
|
424
|
+
- `auth refresh` で新しいトークンを取得
|
|
425
|
+
- `auth token --raw` でスクリプトからトークン取得可能
|
|
426
|
+
|
|
427
|
+
```bash
|
|
428
|
+
# 他コマンドでトークンを使用
|
|
429
|
+
aranea-sdk metatron ask "質問" --token "$(aranea-sdk auth token --raw)"
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
---
|
|
433
|
+
|
|
342
434
|
## 対応デバイスType
|
|
343
435
|
|
|
344
436
|
### 新規 (aranea_ar-*)
|
package/dist/index.js
CHANGED