Skip to content

Commit 739ffaf

Browse files
committed
Updated FAQ for launching Libra
Signed-off-by: Jie Pu <[email protected]>
1 parent dad7102 commit 739ffaf

File tree

2 files changed

+66
-67
lines changed

2 files changed

+66
-67
lines changed

README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,26 @@
44

55
## Overview
66
The biggest differentiating capability of Libra.app compared to other AI Agent products is **localization**. The specific features and dependencies are as follows:
7-
* **Local Mode**: All chats are sent to the local model, requiring the download of a low-bit LLM model optimized for macOS by GreenBitAI, approximately `2.5GB`.
7+
* **Chat Mode**: All chats are sent to the local model, requiring the download of a low-bit LLM model optimized for macOS by GreenBitAI, approximately `2.5GB`.
88
* **Enhanced Mode**: Capable of autonomously performing complex tasks such as file searching, web browsing, programming, charting, and report generation. To better protect user's local data and environment, these operations run in an isolated container environment, requiring the download of a container runtime environment, approximately `1GB` in size.
99

1010
## FAQ
1111

12-
### Network Proxy Configuration During Initialization
12+
### Notes on Starting Libra.app
1313

14-
If you are in one of the following situations, you may need to configure a proxy to ensure that the local model, Enhanced mode, and local upload of documents in formats such as pdf, docx, xlsx can work properly:
15-
* Corporate intranet
16-
* Mainland China
14+
* When starting Libra.app for the first time, it will need to download the model, Agent runtime environment dependencies, etc. These are completed automatically during the startup process and do not require manual configuration by default.
15+
* Currently, the download of these dependencies comes with global CDN acceleration, so you do not need to use any VPN proxy software to make it work.
16+
* It is also recommended not to enable any VPN proxy, as this may affect the normal operation of Libra.app.
17+
* If you encounter similar abnormal situations as described below, you can try to resolve them yourself according to the FAQ instructions, or try to contact the Libra.app technical team via Slack, GitHub, email, etc. for support.
1718

18-
Configure your proxy software to use global proxy mode, or add the following network addresses to the proxy whitelist rules:
19-
* huggingface.co
20-
* ghcr.io
21-
* docker.io
2219

23-
After configuring the proxy, restart `Libra.app` and wait about 10 minutes (readiness time depends on your network). You can confirm whether the above issues exist through the Libra.app interface, or verify more specifically by executing the following commands in the macOS `Terminal` app.
2420

25-
After initialization is complete, it is recommended to disable the proxy.
21+
## Issue Descriptions
2622

27-
> Note: Some proxy software has features like "virtual network card" or "TUN" mode. These modes need to be disabled when using Libra.
23+
### Local Mode Cannot Be Used
24+
Error message: `Loading Local Model`
25+
26+
![](docs/_images/loading-local-model.png)
2827

2928
* Confirm if the local model has been downloaded:
3029
```
@@ -36,43 +35,44 @@ If you see the following content, it indicates the local model has been download
3635
2.5G /Users/libra/.cache/huggingface/hub/models--GreenBitAI--Qwen3-4B-Instruct-2507-layer-mix-bpw-4.0-mlx
3736
```
3837

38+
Before starting, make sure that the relevant VPN proxy software does not have TUN mode or global mode enabled. This may affect the internal process communication of Libra.app.
3939

40-
* Confirm if the container runtime environment is ready:
41-
```
42-
/Applications/Libra.app/Contents/Resources/bin/limactl shell libra nerdctl images
43-
```
44-
45-
If you see the following content, it indicates proper initialization:
46-
```
47-
REPOSITORY TAG IMAGE ID CREATED PLATFORM SIZE BLOB SIZE
48-
ghcr.io/greenbitai/libra-runner v0.6.3 59727661d104 2 days ago linux/arm64 1.781GB 565.6MB
49-
mcp/markitdown latest ac2cdd96f844 10 days ago linux/arm64 982.2MB 353.9MB
50-
```
40+
Or you need to manually configure `localhost`, `127.0.0.1` outside the rules in your VPN software.
5141

42+
If you find that the local model still has not started, you can try restarting Libra.app and wait, and check whether the model has been downloaded correctly.
5243

44+
Alternatively, you can execute the following command to manually download the model:
5345

54-
## Issue Descriptions
55-
56-
### Local Mode Cannot Be Used
57-
Error message: `Loading Local Model`
58-
59-
![](docs/_images/loading-local-model.png)
60-
61-
Refer to [FAQ](./README.md#faq)
46+
```
47+
HF_ENDPOINT=https://hf-mirror.com /Applications/Libra.app/Contents/Resources/bin/gbx_lm.bin --model GreenBitAI/Qwen3-4B-Instruct-2507-layer-mix-bpw-4.0-mlx
48+
```
6249

6350

6451
### Cannot Click Execute Button
6552
Error message: `Execution Engine is not fully ready`
6653

6754
![](docs/_images/execution-engine-not-fully-ready.png)
6855

69-
Refer to [FAQ](./README.md#faq)
7056

7157
### Unable to Parse Uploaded PDF Files
58+
7259
Error message: `The file content is either empty`
7360

7461
![](docs/_images/the-file-content-is-either-empty.png)
7562

76-
Refer to [FAQ](./README.md#faq)
63+
64+
* Confirm if the container runtime environment is ready:
65+
```
66+
/Applications/Libra.app/Contents/Resources/bin/limactl shell libra nerdctl images
67+
```
68+
69+
If you see the following content, it indicates proper initialization:
70+
```
71+
REPOSITORY TAG IMAGE ID CREATED PLATFORM SIZE BLOB SIZE
72+
ghcr.gnbt.io/greenbitai/libra-runner v0.6.9 b5c04942e7ec 18 hours ago linux/arm64 1.785GB 566.9MB
73+
docker.gnbt.io/mcp/markitdown latest a93f01634ef9 19 hours ago linux/arm64 990.8MB 355.6MB
74+
```
75+
76+
If you cannot see two similar records as above, you can try exiting all VPN proxy software and then restarting Libra.app.
7777

7878

README.zh-CN.md

Lines changed: 33 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,25 @@
44

55
## 概述
66
由于Libra.app相比其他同类AI Agent产品来说,最大差异化能力在于**本地化**,具体的特性和其依赖说明如下:
7-
* **Local模式**: Chat都会发送到本地模型,因此需要下载由GreenBitAI针对macOS优化的低比特LLM模型,大约`2.5G`左右。
7+
* **Chat模式**: Chat都会发送到本地模型,因此需要下载由GreenBitAI针对macOS优化的低比特LLM模型,大约`2.5G`左右。
88
* **Enhanced模式**:能自主的进行文件查找、联网搜索、编程绘图、报告生成等复杂指令,为了更好保护用户本地数据和环境,这里通过容器运行环境进行了隔离,因此需要下载容器运行环境,大约`1G`大小。
99

1010
## FAQ
1111

12-
### 初始化阶段网络代理配置
12+
### 启动Libra.app注意事项
1313

14-
如果您是如下情况之一,可能需要配置代理,以保障本地模型、Enhanced模式、本地上传pdf,docx,xlsx等格式文档能正常工作。
15-
* 公司内网
16-
* 中国大陆
14+
* 首次启动Libra.app会需要下载模型、Agent运行环境依赖组件等,这些是启动过程自动完成的,默认情况下不需要手动配置。
15+
* 目前这些依赖的下载已经自带全球CDN加速,所以不需要使用任何VPN代理软件即可工作。
16+
* 而且也建议不要开启任何VPN代理,这可能会影响Libra.app的正常工作。
17+
* 如果碰到类似如下异常情况,可以尝试按照FAQ中的说明自行解决,或者尝试通过 slack, github, mail等方式给Libra.app的技术团队留言以获取支持。
1718

1819

19-
代理软件使用全局代理,或者将以下网络配置在代理白名单规则:
20-
* huggingface.co
21-
* ghcr.io
22-
* docker.io
23-
24-
配置好代理后,重启`Libra.app`,等待10min左右(就绪时长取决于您的网络),可以通过Libra.app界面确定上述问题是否存在,或者通过在macos中的`Terminal`APP中执行如下命令来更具体的进行确认。
20+
## 现象说明
2521

26-
初始化完成后,建议关闭代理使用。
22+
### Local模式无法使用
23+
错误提示:`Loading Local Model`
2724

28-
> 注意:某些代理软件有类似 "虚拟网卡","TUN"模式,使用Libra的时候需要关闭这两种模式。
25+
![](docs/_images/loading-local-model.png)
2926

3027
* 确认本地模式是否下载完成:
3128
```
@@ -37,43 +34,45 @@ du -hd0 ~/.cache/huggingface/hub/models--GreenBitAI--Qwen3-4B-Instruct-2507-laye
3734
2.5G /Users/libra/.cache/huggingface/hub/models--GreenBitAI--Qwen3-4B-Instruct-2507-layer-mix-bpw-4.0-mlx
3835
```
3936

37+
启动之前需要确保相关的VPN代理软件不要开启 TUN 模式 、以及 全局模式。这可能会影响Libra.app内部的进程通信。
4038

41-
* 确认容器运行环境是否就绪:
42-
```
43-
/Applications/Libra.app/Contents/Resources/bin/limactl shell libra nerdctl images
44-
```
45-
46-
看到如下内容则表明已经正确初始化:
47-
```
48-
REPOSITORY TAG IMAGE ID CREATED PLATFORM SIZE BLOB SIZE
49-
ghcr.io/greenbitai/libra-runner v0.6.3 59727661d104 2 days ago linux/arm64 1.781GB 565.6MB
50-
mcp/markitdown latest ac2cdd96f844 10 days ago linux/arm64 982.2MB 353.9MB
51-
```
52-
53-
54-
55-
## 现象说明
39+
或者需要手动在您的VPN软件中,将`localhost`, `127.0.0.1`配置在规则之外。
5640

57-
### Local模式无法使用
58-
错误提示:`Loading Local Model`
41+
如果发现本地模型仍然没有启动,您可以尝试重启Libra.app然后等待,并检查模型是否有正确下载。
5942

60-
![](docs/_images/loading-local-model.png)
43+
或者您也可以执行如下命令,进行手动下载模型。
6144

62-
参考 [FAQ](./README.zh-CN.md#faq)
45+
```
46+
HF_ENDPOINT=https://hf-mirror.com /Applications/Libra.app/Contents/Resources/bin/gbx_lm.bin --model GreenBitAI/Qwen3-4B-Instruct-2507-layer-mix-bpw-4.0-mlx
47+
```
6348

6449

6550
### 无法点击Execute按钮
6651
错误提示:`Execution Engine is not fully ready`
6752

6853
![](docs/_images/execution-engine-not-fully-ready.png)
6954

70-
参考 [FAQ](./README.zh-CN.md#faq)
7155

7256
### 上传pdf等文件后无法解析
7357

7458
错误提示:`The file content is either empty`
7559

7660
![](docs/_images/the-file-content-is-either-empty.png)
7761

78-
参考 [FAQ](./README.zh-CN.md#faq)
62+
63+
* 确认容器运行环境是否就绪:
64+
```
65+
/Applications/Libra.app/Contents/Resources/bin/limactl shell libra nerdctl images
66+
```
67+
68+
看到如下内容则表明已经正确初始化:
69+
```
70+
REPOSITORY TAG IMAGE ID CREATED PLATFORM SIZE BLOB SIZE
71+
ghcr.gnbt.io/greenbitai/libra-runner v0.6.9 b5c04942e7ec 18 hours ago linux/arm64 1.785GB 566.9MB
72+
docker.gnbt.io/mcp/markitdown latest a93f01634ef9 19 hours ago linux/arm64 990.8MB 355.6MB
73+
```
74+
75+
如果无法看到类似上面的两行记录,您可以尝试退出所有VPN代理软件后,重启Libra.app代理。
76+
77+
7978

0 commit comments

Comments
 (0)