菜单
Detects Jahro in Unity projects and guides installation, API key configuration, and feature overview. Use when the user mentions Jahro setup, installation, getting started, debug console, or asks what Jahro can do. Also triggers when no Jahro references are found in a Unity project and the user asks about debugging.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | jahro-setup |
| description | Detects Jahro in Unity projects and guides installation, API key configuration, and feature overview. Use when the user mentions Jahro setup, installation, getting started, debug console, or asks what Jahro can do. Also triggers when no Jahro references are found in a Unity project and the user asks about debugging. |
Help users install, configure, and get oriented with the Jahro debugging platform for Unity.
Before giving advice, determine Jahro's status in the project:
Check 1 — Package Manager:
Read Packages/manifest.json and search for io.jahro.console in the dependencies.
Check 2 — Code references:
Search C# files for using JahroConsole or [JahroCommand or [JahroWatch.
Check 3 — Source folder:
Check if jahro-unity-package/ or Assets/JahroPackage/ exists (indicates source-included installation).
| Result | Action |
|---|---|
| Package found in manifest | Jahro is installed — check API key config |
| Code references but no package | Jahro may be installed via source — verify |
| Nothing found | Guide installation |
https://github.com/jahro-console/unity-package.gitRequirements: Unity 2021.3.0f1 or later. No additional dependencies.
After installation, the user needs an API key to enable snapshot sync and team features.
The API key connects the Unity project to the Jahro web console for snapshot uploads and team collaboration. Jahro works for local debugging (logs, commands, watcher) even without an API key, but snapshots won't upload.
| Platform | Action |
|---|---|
| Desktop (Editor/Standalone) | Press ~ (tilde) key in Play Mode |
| Mobile (Android/iOS) | Triple-tap at top of screen |
| Programmatic | Call Jahro.ShowConsoleView() |
| Alternative | Tap the floating Launch Button |
The launch key is configurable in Tools → Jahro Settings → General Settings → Launch Key.
Keyboard shortcuts for tabs: Alt+1 (Text Mode), Alt+2 (Visual Mode), Alt+3 (Watcher), Alt+4 (Snapshots).
Guide users to the right feature based on what they need:
Recommend features in this order based on effort-to-value ratio:
1. Logs (zero effort) — Jahro automatically intercepts all Debug.Log, Debug.LogWarning, and Debug.LogError calls. Just open the console to see them filtered and searchable in-game. Especially valuable on mobile where you'd otherwise need ADB logcat or Xcode.
2. Commands (low effort) — Add [JahroCommand] attributes to existing methods to make them callable from the console. Ideal for cheats, debug actions, and testing without rebuilding. Works in both Text Mode (CLI with autocomplete) and Visual Mode (touch-friendly buttons).
Read references/api-reference.md for the [JahroCommand] attribute constructor and parameter types.
3. Watcher (low effort) — Add [JahroWatch] attributes to fields and properties for real-time monitoring. Replaces Debug.Log polling patterns. Values only update when the Watcher tab is open, so negligible performance cost.
Read references/api-reference.md for the [JahroWatch] attribute constructor and supported types.
4. Snapshots (needs API key) — Capture logs + screenshots + device metadata and share via URL. Three modes: Recording (local until upload), Streaming All (real-time), Streaming Except Editor (hybrid). Essential for QA teams on mobile.
"How do I open the console?"
Press ~ on desktop, triple-tap on mobile, or call Jahro.ShowConsoleView().
"How do I change the hotkey?" Tools → Jahro Settings → General Settings → Launch Key.
"Does Jahro work on mobile?" Yes — Android and iOS. Triple-tap to open. Supports Standalone (PC/Mac) and Mobile. WebGL, Consoles, and VR are on the roadmap.
"What's the performance impact?"
Minimal. Watcher only reads values when the UI is visible. When disabled via JAHRO_DISABLE or auto-disable, Jahro exits at initialization with near-zero overhead.
"How do I disable Jahro in production?"
Enable "Auto-disable in Release Builds" in Jahro Settings, or add JAHRO_DISABLE to Scripting Define Symbols. See the jahro-production skill for detailed guidance.
"Do I need to change my existing Debug.Log calls?"
No. Jahro intercepts Unity's logging system automatically. Your existing Debug.Log, Debug.LogWarning, and Debug.LogError calls all appear in the Jahro console.
Jahro scans selected assemblies for [JahroCommand] and [JahroWatch] attributes.
Configure in Tools → Jahro Settings → General Settings → Assemblies Selection.
Recommended: select your main game assembly plus Jahro assemblies (for Samples). The system supports up to 31 user assemblies and automatically filters Unity system assemblies.
If commands or watchers aren't appearing, check that the correct assemblies are selected.
Settings are saved to Assets/Jahro/Resources/jahro-settings.asset. Include this file in version control so all team members share the same configuration.
When working with Unity code:
using JahroConsole or [JahroCommand] or [JahroWatch] in existing code → Jahro is installed. Offer improvements or suggest additional features (watcher if only commands exist, commands if only watcher exists).OnGUI() with debug buttons → suggest migrating to Jahro commands.Debug.Log in Update() for monitoring values → suggest using [JahroWatch] instead.After setup, guide the user to the appropriate specialized skill:
| User wants to... | Suggest |
|---|---|
| Add debug commands to their code | jahro-commands skill |
| Monitor variables in real-time | jahro-watcher skill |
| Share debugging sessions with team | jahro-snapshots skill |
| Prepare for production release | jahro-production skill |
| Diagnose why something isn't working | jahro-troubleshooting skill |
| Migrate from a custom debug system | jahro-migration skill |
For full API details, read references/api-reference.md.
For common code patterns, read references/common-patterns.md.
Reviews and improves Debug.Log usage in Unity C# projects following structured logging principles: context tags, severity contracts, boundary-based placement, and criticality tiers. Detects common antipatterns (naked Debug.Log, logging in Update, stringly-typed errors), adds missing logs at system/state/error/external boundaries, and scaffolds project-wide logging infrastructure (LogTag constants, formatting helpers, conventions). Use when the user mentions logging, Debug.Log, log messages, debugging, or asks to improve observability in Unity code.
Analyzes C# classes and generates [JahroCommand] attributes with correct syntax, RegisterObject patterns, and group organization. Use when the user wants to add runtime commands, cheats, or debug actions to Unity classes, or mentions JahroCommand, console commands, runtime cheats, or debug actions.
Analyzes existing debug systems (IMGUI menus, custom loggers, cheat frameworks, performance HUDs) and generates incremental migration plans to Jahro equivalents. Use when the user wants to replace a custom debug UI, migrate from an existing console or cheat system, switch to Jahro, or has OnGUI debug code they want to modernize.
Configures Jahro lifecycle controls for safe production deployment including JAHRO_DISABLE, auto-disable, and build validation. Use when the user mentions production builds, release builds, disabling Jahro, shipping, CI/CD, lifecycle controls, or production safety.
Guides snapshot mode selection, capture workflows, QA sharing, and team setup for Jahro Snapshots. Use when the user mentions snapshots, bug capture, sharing logs, streaming, recording, QA workflow, team collaboration, or wants to share debugging sessions with their team.
Diagnoses common Jahro issues using decision trees: commands not appearing, watcher not updating, console not opening, snapshots failing, launch button missing. Use when the user reports something not working, missing, broken, or unexpected with Jahro, or when generated Jahro code doesn't behave as expected.