uloop-get-logs · diff
git:20260616.7cb6f01 to git:20260618.13795c5
1 added, 6 removed. Audit A to A.
---
name: uloop-get-logs
toolName: get-logs
description: "Read current Unity Console entries from a running Editor. Use during bug investigation after compile, tests, PlayMode, dynamic code, or immediately after `uloop-wait-for-pause-point`."
---
# uloop get-logs
Retrieve logs from Unity Console.
- When a pause-point marker pauses Unity and the value you need is a method local, intermediate calculation, or branch reason, read the focused `Debug.Log` entry added immediately before the marker before resuming PlayMode. Use `--search-text <marker-or-id>` so the marker and its log are checked as one breakpoint-style proof.
-
## Usage
```bash
uloop get-logs [options]
```
## Parameters
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `--log-type` | string | `All` | Log type filter: `Error`, `Warning`, `Log`, `All` |
| `--max-count` | integer | `100` | Maximum number of logs to retrieve |
| `--search-text` | string | - | Text to search within logs |
| `--include-stack-trace` | flag | - | Include stack trace in output |
| `--use-regex` | flag | - | Use regex for search |
| `--search-in-stack-trace` | flag | - | Search within stack trace |
## Global Options
| Option | Description |
|--------|-------------|
| `--project-path <path>` | Optional. Use only when the target Unity project is not the current directory. |
## Examples
```bash
# Get all logs
uloop get-logs
# Get only errors
uloop get-logs --log-type Error
# Search for specific text
uloop get-logs --search-text "NullReference"
# Regex search
uloop get-logs --search-text "Missing.*Component" --use-regex
```
## Output
Returns JSON with:
- `totalCount` (number): Total logs available before max-count clipping
- `displayedCount` (number): Logs returned in this response (≤ `--max-count`)
- - `logType` (string): The `--log-type` filter that was applied
- - `maxCount` (number): The `--max-count` cap that was applied
- - `searchText` (string): The `--search-text` filter that was applied (empty when omitted)
- - `includeStackTrace` (boolean): Whether stack traces are included in `logs[]`
+ - Input filters (`logType`, `maxCount`, `searchText`, `includeStackTrace`) are echoed back in the response
- `logs` (array): Each entry has:
- `type` (string): `"Error"`, `"Warning"`, or `"Log"`
- `message` (string): Log message body
- `stackTrace` (string): Stack trace text. Empty when `--include-stack-trace` is `false`.