Unity-Shell

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #golang #deep-learning #linux #docker #macos #nodejs #vue #mcp #openai

(★ 17)

简单好用又强大的UnityEditor命令行调用小工具，支持彩色日志、统一编码、多步输出、可等待等

Unity-Shell Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Unity-Shell](https://socialify.git.ci/labbbirder/Unity-Shell/image?description=1&forks=1&issues=1&name=1&owner=1&stargazers=1&theme=Auto)

![GitHub last commit](https://img.shields.io/github/last-commit/labbbirder/Unity-Shell)
![GitHub package.json version](https://img.shields.io/github/package-json/v/labbbirder/Unity-Shell)
[![openupm](https://img.shields.io/npm/v/com.bbbirder.shell?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.bbbirder.shell/)

简单易用且功能丰富 Unity 命令行模块，用于 Editor 下调用命令行。兼容Windows和Mac OS。

## Features List

重定向标准输出流到 Unity 控制台，支持众多特性。

### Multi-threaded

不显示窗口，不干扰开发者；异步执行，不用担心阻塞 Unity 线程。

### Waitable

可等待调用结果。支持同步方式和异步方式。

### Color Log

支持从标准输出流中识别彩色 log，并无缝对接到 UnityConsole。如下是执行`ncu --color -g`的输出结果：

![color-log](https://raw.githubusercontent.com/labbbirder/Unity-Shell/main/Documentation/color-log.png)

### Encoding

Windows 下，支持特殊字符、中文、英文等，不再受乱码困扰。

![unicode](https://raw.githubusercontent.com/labbbirder/Unity-Shell/main/Documentation/unicode.png)

> 需要在 PlayerSetting 中指定宏：DETECT_STDOUT_ENCODING（不推荐），则会实时猜测输出流编码。或修改系统设置（推荐）。如下图：
>
> ![windows](https://raw.githubusercontent.com/labbbirder/Unity-Shell/main/Documentation/config_sys.png)
>
> 使用编码猜测的方式并不完全可靠，可能遇到奇怪的问题，因此默认关闭。

### Immediate Log One By One

多步打印实时转发，可视化执行过程

![one-by-one](https://raw.githubusercontent.com/labbbirder/Unity-Shell/main/Documentation/one-by-one.png)

### Backgound Task View

右下角后台任务可以预览和管理正在运行的command

点击关闭发送关闭消息；点击暂停发送用户输入。

![background](https://raw.githubusercontent.com/labbbirder/Unity-Shell/main/Documentation/background.png)

![input](https://raw.githubusercontent.com/labbbirder/Unity-Shell/main/Documentation/input.png)

## Install

Add git url `https://github.com/labbbirder/Unity-Shell.git` to package manager

Execute shell in project root:

```bash
openupm add com.bbbirder.shell
```

## Basic Usage

Run a shell:

```csharp
using com.bbbirder.unityeditor;

// single line
Shell.RunCommand("python -V");

// multiple line
Shell.RunCommand(@"
    echo start
    ping baidu.com -n 6
    echo end
");

// separate arguments
Shell.RunCommandLine("ping", "baidu.com", "-n", 20);
```

等待结果：

```csharp
// 异步方式
async void Foo()
{
    var result = await Shell.RunCommand("python -V");
    Debug.Log(result.Output);   // output: 3.11.2
    Debug.Log(result.ExitCode); // output: 0
}

// 同步方式
void Bar()
{
    var result = Shell.RunCommand("python -V").Wait();
    Debug.Log(result.Output);   // output: 3.11.2
    Debug.Log(result.ExitCode); // output: 0
}

// 协程方式
IEnumerator Baz()
{
    var request = Shell.RunCommand("python -V");
    yield return request.ToCoroutine();
    var result = request.result;
    Debug.Log(result.Output);   // output: 3.11.2
    Debug.Log(result.ExitCode); // output: 0
}
```

判断命令行工具是否存在:

```csharp
var hasTsNodeCli = Shell.ExistsCommand("ts-node");
```

## Unity 控制台设置

如果需要美化打印，可设置 UnityConsole 如下：

![unity](https://raw.githubusercontent.com/labbbirder/Unity-Shell/main/Documentation/config_unity.png)

Unity-Shell

Unity-Shell Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Unity-Shell

Unity-Shell Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README