From 7f5a717694d3a94f19f523b375c777eb21548ff5 Mon Sep 17 00:00:00 2001 From: Lum1104 Date: Fri, 19 Jun 2026 11:37:38 +0800 Subject: [PATCH] docs: note local-model option and token-usage expectations in install steps --- .claude-plugin/plugin.json | 2 +- .copilot-plugin/plugin.json | 2 +- .cursor-plugin/plugin.json | 2 +- README.md | 4 ++++ READMEs/README.es-ES.md | 4 ++++ READMEs/README.ja-JP.md | 4 ++++ READMEs/README.ko-KR.md | 4 ++++ READMEs/README.ru-RU.md | 4 ++++ READMEs/README.tr-TR.md | 4 ++++ READMEs/README.zh-CN.md | 4 ++++ READMEs/README.zh-TW.md | 4 ++++ understand-anything-plugin/.claude-plugin/plugin.json | 2 +- understand-anything-plugin/package.json | 2 +- 13 files changed, 37 insertions(+), 5 deletions(-) diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json index 3f018c3..0dda036 100644 --- a/.claude-plugin/plugin.json +++ b/.claude-plugin/plugin.json @@ -1,7 +1,7 @@ { "name": "understand-anything", "description": "AI-powered codebase understanding — analyze, visualize, and explain any project", - "version": "2.8.0", + "version": "2.8.1", "author": { "name": "Egonex" }, diff --git a/.copilot-plugin/plugin.json b/.copilot-plugin/plugin.json index 7d55745..8236964 100644 --- a/.copilot-plugin/plugin.json +++ b/.copilot-plugin/plugin.json @@ -1,7 +1,7 @@ { "name": "understand-anything", "description": "AI-powered codebase understanding — analyze, visualize, and explain any project", - "version": "2.8.0", + "version": "2.8.1", "author": { "name": "Egonex" }, diff --git a/.cursor-plugin/plugin.json b/.cursor-plugin/plugin.json index d6f6791..7b2d5c9 100644 --- a/.cursor-plugin/plugin.json +++ b/.cursor-plugin/plugin.json @@ -2,7 +2,7 @@ "name": "understand-anything", "displayName": "Understand Anything", "description": "AI-powered codebase understanding — analyze, visualize, and explain any project", - "version": "2.8.0", + "version": "2.8.1", "author": { "name": "Egonex" }, diff --git a/README.md b/README.md index 98ab4cc..7115a46 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,8 @@ Point `/understand-knowledge` at a [Karpathy-pattern LLM wiki](https://gist.gith /plugin install understand-anything ``` +> **Using a local model?** For privacy or enterprise setups, point your platform at a local model provider such as [Ollama](https://docs.ollama.com/integrations) — follow their integration guide to change the model provider. + ### 2. Analyze your codebase ```bash @@ -125,6 +127,8 @@ Point `/understand-knowledge` at a [Karpathy-pattern LLM wiki](https://gist.gith A multi-agent pipeline scans your project, extracts every file, function, class, and dependency, then builds a knowledge graph saved to `.understand-anything/knowledge-graph.json`. +> **Heads up on token usage:** The initial `/understand` analyzes your whole codebase and can consume a significant number of tokens on large projects. We recommend running it on a token plan / subscription, or using a local model (see above) for initialization. Subsequent runs are incremental by default — only changed files are re-analyzed — so they use far fewer tokens. + **Localized output:** Use `--language` to generate content in your preferred language: ```bash diff --git a/READMEs/README.es-ES.md b/READMEs/README.es-ES.md index 6f54996..2ad27bf 100644 --- a/READMEs/README.es-ES.md +++ b/READMEs/README.es-ES.md @@ -107,6 +107,8 @@ Apunta `/understand-knowledge` a un [wiki LLM con patrón Karpathy](https://gist /plugin install understand-anything ``` +> **¿Usas un modelo local?** Para configuraciones de privacidad o empresariales, apunta tu plataforma a un proveedor de modelos local como [Ollama](https://docs.ollama.com/integrations) — sigue su guía de integración para cambiar el proveedor de modelo. + ### 2. Analiza tu código ```bash @@ -115,6 +117,8 @@ Apunta `/understand-knowledge` a un [wiki LLM con patrón Karpathy](https://gist Un pipeline multi-agente escanea tu proyecto, extrae cada archivo, función, clase y dependencia, y construye un grafo de conocimiento guardado en `.understand-anything/knowledge-graph.json`. +> **Aviso sobre el consumo de tokens:** El primer `/understand` analiza todo tu código y puede consumir una cantidad significativa de tokens en proyectos grandes. Recomendamos ejecutarlo con un plan / suscripción de tokens, o usar un modelo local (ver arriba) para la inicialización. Las ejecuciones posteriores son incrementales por defecto — solo se reanalizan los archivos modificados — por lo que usan muchos menos tokens. + **Salida localizada:** Usa `--language` para generar contenido en tu idioma preferido: ```bash diff --git a/READMEs/README.ja-JP.md b/READMEs/README.ja-JP.md index 7edb429..aba4de2 100644 --- a/READMEs/README.ja-JP.md +++ b/READMEs/README.ja-JP.md @@ -108,6 +108,8 @@ Understand Anything は [Claude Code Plugin](https://code.claude.com/docs/en/plu /plugin install understand-anything ``` +> **ローカルモデルを使う場合:** プライバシーやエンタープライズ用途では、[Ollama](https://docs.ollama.com/integrations) などのローカルモデルプロバイダーにプラットフォームを向けてください。統合ガイドに従ってモデルプロバイダーを変更できます。 + ### 2. コードベースを分析 ```bash @@ -116,6 +118,8 @@ Understand Anything は [Claude Code Plugin](https://code.claude.com/docs/en/plu マルチエージェントパイプラインがプロジェクトをスキャンし、すべてのファイル・関数・クラス・依存関係を抽出して、`.understand-anything/knowledge-graph.json` にナレッジグラフを保存します。 +> **トークン使用量にご注意:** 初回の `/understand` はコードベース全体を分析するため、大規模プロジェクトではかなりのトークンを消費することがあります。トークンプラン / サブスクリプションでの実行、または初期化にはローカルモデル（上記参照）の使用をおすすめします。以降の実行はデフォルトで増分処理され、変更されたファイルのみ再分析するため、消費トークンは大幅に少なくなります。 + **ローカライズされた出力：** `--language` を使用して、希望の言語でコンテンツを生成： ```bash diff --git a/READMEs/README.ko-KR.md b/READMEs/README.ko-KR.md index f89811f..51d5c63 100644 --- a/READMEs/README.ko-KR.md +++ b/READMEs/README.ko-KR.md @@ -107,6 +107,8 @@ Understand Anything은 [Claude Code Plugin](https://code.claude.com/docs/en/plug /plugin install understand-anything ``` +> **로컬 모델을 사용하시나요?** 개인정보 보호나 엔터프라이즈 환경에서는 [Ollama](https://docs.ollama.com/integrations) 같은 로컬 모델 제공자를 사용하도록 플랫폼을 설정하세요 — 통합 가이드를 따라 모델 제공자를 변경할 수 있습니다. + ### 2. 코드베이스 분석 ```bash @@ -115,6 +117,8 @@ Understand Anything은 [Claude Code Plugin](https://code.claude.com/docs/en/plug 멀티 에이전트 파이프라인이 프로젝트를 스캔하고, 모든 파일, 함수, 클래스, 의존성을 추출한 뒤, `.understand-anything/knowledge-graph.json`에 지식 그래프를 저장합니다. +> **토큰 사용량 안내:** 최초 `/understand`는 전체 코드베이스를 분석하므로 대규모 프로젝트에서는 상당한 토큰을 소비할 수 있습니다. 토큰 요금제 / 구독으로 실행하거나, 초기화에는 로컬 모델(위 참조)을 사용하는 것을 권장합니다. 이후 실행은 기본적으로 증분 방식이라 변경된 파일만 다시 분석하므로 훨씬 적은 토큰을 사용합니다. + **로컬라이즈된 출력:** `--language`를 사용하여 원하는 언어로 내용을 생성: ```bash diff --git a/READMEs/README.ru-RU.md b/READMEs/README.ru-RU.md index 01ee347..2601db8 100644 --- a/READMEs/README.ru-RU.md +++ b/READMEs/README.ru-RU.md @@ -108,6 +108,8 @@ Understand Anything — это [плагин для Claude Code](https://code.cl /plugin install understand-anything ``` +> **Используете локальную модель?** Для приватных или корпоративных сценариев направьте свою платформу на локального провайдера моделей, например [Ollama](https://docs.ollama.com/integrations) — следуйте его руководству по интеграции, чтобы сменить провайдера модели. + ### 2. Проанализируйте кодовую базу ```bash @@ -116,6 +118,8 @@ Understand Anything — это [плагин для Claude Code](https://code.cl Мультиагентный пайплайн сканирует ваш проект, извлекает каждый файл, функцию, класс и зависимость, а затем строит граф знаний и сохраняет его в `.understand-anything/knowledge-graph.json`. +> **Обратите внимание на расход токенов:** Первый запуск `/understand` анализирует всю кодовую базу и может потреблять значительное количество токенов на больших проектах. Рекомендуем запускать его с тарифным планом / подпиской на токены или использовать локальную модель (см. выше) для инициализации. Последующие запуски по умолчанию инкрементальны — повторно анализируются только изменённые файлы — поэтому расходуют гораздо меньше токенов. + **Локализованный вывод:** используйте `--language`, чтобы генерировать контент на нужном языке: ```bash diff --git a/READMEs/README.tr-TR.md b/READMEs/README.tr-TR.md index c2ba0fa..3a1f8ee 100644 --- a/READMEs/README.tr-TR.md +++ b/READMEs/README.tr-TR.md @@ -108,6 +108,8 @@ Alan görünümüne geçin ve kodunuzun gerçek iş süreçleriyle nasıl eşle /plugin install understand-anything ``` +> **Yerel model mi kullanıyorsunuz?** Gizlilik veya kurumsal kurulumlar için platformunuzu [Ollama](https://docs.ollama.com/integrations) gibi yerel bir model sağlayıcısına yönlendirin — model sağlayıcısını değiştirmek için entegrasyon kılavuzunu izleyin. + ### 2. Kod tabanını analiz et ```bash @@ -116,6 +118,8 @@ Alan görünümüne geçin ve kodunuzun gerçek iş süreçleriyle nasıl eşle Çok-ajan hattı projenizi tarar, her dosya, fonksiyon, sınıf ve bağımlılığı çıkarır, ardından `.understand-anything/knowledge-graph.json` dosyasına kaydedilen bir bilgi grafiği oluşturur. +> **Token kullanımı hakkında uyarı:** İlk `/understand` çalıştırması tüm kod tabanınızı analiz eder ve büyük projelerde önemli miktarda token tüketebilir. Bunu bir token planı / aboneliği ile çalıştırmanızı veya başlatma için yerel bir model (yukarıya bakın) kullanmanızı öneririz. Sonraki çalıştırmalar varsayılan olarak artımlıdır — yalnızca değişen dosyalar yeniden analiz edilir — bu yüzden çok daha az token kullanır. + **Yerelleştirilmiş çıktı:** İstediğiniz dilde içerik oluşturmak için `--language` kullanın: ```bash diff --git a/READMEs/README.zh-CN.md b/READMEs/README.zh-CN.md index c456a3d..890db1d 100644 --- a/READMEs/README.zh-CN.md +++ b/READMEs/README.zh-CN.md @@ -107,6 +107,8 @@ Understand Anything 是一个 [Claude Code Plugin](https://code.claude.com/docs/ /plugin install understand-anything ``` +> **使用本地模型？** 出于隐私或企业需求，可以将你的平台指向本地模型提供方，例如 [Ollama](https://docs.ollama.com/integrations) —— 按照其集成指南更改模型提供方。 + ### 2. 分析你的代码库 ```bash @@ -115,6 +117,8 @@ Understand Anything 是一个 [Claude Code Plugin](https://code.claude.com/docs/ 多智能体（multi-agent）架构会：扫描你的项目，提取函数 / 类 / 依赖，构建知识图谱保存至`.understand-anything/knowledge-graph.json`. +> **关于 Token 消耗的提醒：** 首次运行 `/understand` 会分析整个代码库，在大型项目上可能消耗大量 token。建议在有 token 套餐 / 订阅的情况下运行，或在初始化时使用本地模型（见上文）。后续运行默认是增量式的——只重新分析变更过的文件——因此消耗的 token 大幅减少。 + **本地化输出：** 使用 `--language` 参数生成中文内容： ```bash diff --git a/READMEs/README.zh-TW.md b/READMEs/README.zh-TW.md index 01c0e3e..4925828 100644 --- a/READMEs/README.zh-TW.md +++ b/READMEs/README.zh-TW.md @@ -107,6 +107,8 @@ Understand Anything 是一個 [Claude Code Plugin](https://code.claude.com/docs/ /plugin install understand-anything ``` +> **使用本地模型？** 基於隱私或企業需求，可以將你的平台指向本地模型提供方，例如 [Ollama](https://docs.ollama.com/integrations) —— 依照其整合指南變更模型提供方。 + ### 2. 分析你的程式碼庫 ```bash @@ -115,6 +117,8 @@ Understand Anything 是一個 [Claude Code Plugin](https://code.claude.com/docs/ 多智能體（multi-agent）架構會：掃描你的專案，提取函式 / 類別 / 相依關係，建構知識圖譜並儲存至 `.understand-anything/knowledge-graph.json`。 +> **關於 Token 消耗的提醒：** 首次執行 `/understand` 會分析整個程式碼庫，在大型專案上可能消耗大量 token。建議在有 token 方案 / 訂閱的情況下執行，或在初始化時使用本地模型（見上文）。後續執行預設為增量式——只重新分析變更過的檔案——因此消耗的 token 大幅減少。 + **在地化輸出：** 使用 `--language` 參數產生中文內容： ```bash diff --git a/understand-anything-plugin/.claude-plugin/plugin.json b/understand-anything-plugin/.claude-plugin/plugin.json index 3f018c3..0dda036 100644 --- a/understand-anything-plugin/.claude-plugin/plugin.json +++ b/understand-anything-plugin/.claude-plugin/plugin.json @@ -1,7 +1,7 @@ { "name": "understand-anything", "description": "AI-powered codebase understanding — analyze, visualize, and explain any project", - "version": "2.8.0", + "version": "2.8.1", "author": { "name": "Egonex" }, diff --git a/understand-anything-plugin/package.json b/understand-anything-plugin/package.json index 67b9633..ab2f971 100644 --- a/understand-anything-plugin/package.json +++ b/understand-anything-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@understand-anything/skill", - "version": "2.8.0", + "version": "2.8.1", "type": "module", "main": "dist/index.js", "types": "dist/index.d.ts",