kuddev
ffec205e01
Settings → Home → Project and support gains a Sponsors row that opens an in-app page (logo on the left, bilingual introduction on the right) with a single sign-up link carrying the project's attribution parameters. Both READMEs add a matching Sponsors table and the community Discord invite.
217 lines
10 KiB
Markdown
217 lines
10 KiB
Markdown
<p align="center">
|
||
<img src="extra/logo/nebula.png" alt="Pebrel Titanium icon" width="148" height="148" />
|
||
</p>
|
||
|
||
<h1 align="center">Pebrel</h1>
|
||
|
||
<p align="center">
|
||
<strong>A GPU-accelerated terminal, SSH workspace, and home for your AI CLI sessions.</strong>
|
||
</p>
|
||
|
||
<p align="center">
|
||
Built with Rust and GPUI for Windows, macOS, and Linux.<br />
|
||
Split terminals · SSH & SFTP · Claude Code & Codex workflows · Native document reader
|
||
</p>
|
||
|
||
<p align="center">
|
||
<img src="https://img.shields.io/badge/Rust-2024_edition-CE412B?style=for-the-badge&logo=rust&logoColor=white" alt="Rust" />
|
||
<img src="https://img.shields.io/badge/OpenGL-ES_2.0%2B-5586A4?style=for-the-badge&logo=opengl&logoColor=white" alt="OpenGL ES 2.0+" />
|
||
<img src="https://img.shields.io/badge/Windows-10_%2F_11-0078D6?style=for-the-badge&logo=windows11&logoColor=white" alt="Windows 10 and 11" />
|
||
<img src="https://img.shields.io/badge/macOS-14%2B-000000?style=for-the-badge&logo=apple&logoColor=white" alt="macOS 14+" />
|
||
<img src="https://img.shields.io/badge/Linux-glibc_2.35%2B-FCC624?style=for-the-badge&logo=linux&logoColor=black" alt="Linux glibc 2.35+" />
|
||
<img src="https://img.shields.io/badge/PowerShell-Pebrel_prompt-5391FE?style=for-the-badge&logo=powershell&logoColor=white" alt="PowerShell" />
|
||
<img src="https://img.shields.io/badge/License-GPL--3.0-1f6feb?style=for-the-badge" alt="GPL-3.0 license" />
|
||
</p>
|
||
|
||
<p align="center">
|
||
<img src="https://img.shields.io/github/stars/Kuddev/pebrel?style=flat-square&color=ffd33d&logo=github" alt="Stars" />
|
||
<img src="https://img.shields.io/github/forks/Kuddev/pebrel?style=flat-square&color=8957e5&logo=github" alt="Forks" />
|
||
<img src="https://img.shields.io/github/last-commit/Kuddev/pebrel?style=flat-square&color=3fb950" alt="Last commit" />
|
||
<a href="https://discord.gg/VFn4rcxmhn"><img src="https://img.shields.io/badge/Discord-join-5865F2?style=flat-square&logo=discord&logoColor=white" alt="Discord" /></a>
|
||
<a href="https://linux.do"><img src="https://img.shields.io/badge/%E5%8F%8B%E9%93%BE-linux.do-ffb003?style=flat-square&logo=discourse&logoColor=white" alt="linux.do" /></a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<strong>English</strong> · <a href="README.zh-CN.md">简体中文</a>
|
||
</p>
|
||
|
||
---
|
||
|
||
<p align="center">
|
||
<img src="docs/screenshots/nebula-top-tabs.png" alt="Terminal tabs in Pebrel" width="1040" />
|
||
</p>
|
||
|
||
<p align="center">
|
||
<img src="docs/screenshots/nebula-claude-session.png" alt="Claude Code running in Pebrel" width="1040" />
|
||
</p>
|
||
|
||
<p align="center">
|
||
<img src="docs/screenshots/split-ai-workflows.png" alt="OpenCode, Claude Code, and Codex in split panes" width="1040" />
|
||
</p>
|
||
|
||
## 💖 Sponsors
|
||
|
||
<table>
|
||
<tr>
|
||
<td align="center" width="240">
|
||
<a href="https://fluxionai.space/register?source=github&campaign=pebrel&promo=pebrel"><img src="extra/logo/sponsor_fluxionai.png" alt="Fluxion AI" width="200" /></a><br />
|
||
<a href="https://fluxionai.space/register?source=github&campaign=pebrel&promo=pebrel"><strong>Fluxion AI</strong></a>
|
||
</td>
|
||
<td>
|
||
Thanks to Fluxion AI for sponsoring this project! Fluxion AI is one entry point for accessing and managing the world's leading AI models. It serves individual developers, technical teams and enterprises with a unified API; dynamic multi-route scheduling improves availability, and model performance, response time and cost stay transparent. Depending on the model and route, API calls can cost 40%–98% less than official or benchmark prices. <a href="https://fluxionai.space/register?source=github&campaign=pebrel&promo=pebrel">Sign up via this link</a> to receive $3 in API credit.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
## One Workspace
|
||
|
||
Pebrel (formerly Nebula) brings local shells, remote hosts, files, and AI command-line
|
||
tools into a native desktop workspace. Arrange terminals in tabs and splits, follow
|
||
each agent's activity, and read its output without leaving the application.
|
||
|
||
### Terminals and Sessions
|
||
|
||
- Sidebar or top tabs, draggable split panes, and per-pane working directories.
|
||
- Saved workspace layouts and optional AI conversation restoration. On WSL and
|
||
Linux, Codex session metadata can supply an ID when its hook has not reported one.
|
||
- On Windows, optional background residency keeps running sessions alive when you
|
||
close the window. Restoring a conversation after the process exits is a separate
|
||
feature and requires a supported CLI and a usable session identity.
|
||
- History and path completions, configurable keybindings, and integrated shell prompts.
|
||
|
||
### SSH and Files
|
||
|
||
- Saved hosts, SSH config aliases, proxy and jump-host options, private-key and
|
||
keyboard-interactive authentication, and host-key verification.
|
||
- SFTP browsing, uploads and downloads, folder transfers, progress, and cancellation.
|
||
- Local file browsing and Git actions alongside your terminals.
|
||
- Duplicated WSL and SSH tabs retain their known working directory.
|
||
|
||
<p align="center">
|
||
<img src="docs/screenshots/ssh.gif" alt="Native SSH session" width="1040" />
|
||
</p>
|
||
|
||
### AI CLI Workflows
|
||
|
||
- Claude Code, Codex, and other recognized CLIs have their own icons and activity
|
||
states. Supported hook events provide more precise progress and attention signals.
|
||
- Notifications follow their source pane; clicking one returns you to that terminal.
|
||
- Captured Claude Code and Codex answers open in a reader with Markdown, formulas,
|
||
source text, and local image previews.
|
||
- Clipboard images are saved as PNG files and their paths inserted into local,
|
||
WSL, or SSH sessions. Inline terminal images require the CLI to emit the supported
|
||
OSC 1337 protocol; image attachment previews depend on the CLI itself.
|
||
|
||
<p align="center">
|
||
<img src="docs/screenshots/ai-sidebar.png" alt="AI activity sidebar" width="300" />
|
||
</p>
|
||
|
||
### A Native, Configurable Interface
|
||
|
||
- GPU-accelerated GPUI interface, light and dark themes, backgrounds, and opacity controls.
|
||
- Application icon palettes and eleven UI language choices with English fallback
|
||
for untranslated text.
|
||
- Searchable settings, a command palette, and Lua configuration with validation and
|
||
live reload. Existing TOML configuration remains supported.
|
||
- Markdown document tabs and native mathematical typesetting without a WebView.
|
||
|
||
<p align="center">
|
||
<img src="docs/screenshots/native-math-rendering.png" alt="Native formula rendering" width="1040" />
|
||
</p>
|
||
|
||
<p align="center">
|
||
<img src="docs/screenshots/themes.png" alt="Application themes" width="1040" />
|
||
</p>
|
||
|
||
## Download
|
||
|
||
Choose a package from the **[latest release](https://github.com/Kuddev/pebrel/releases/latest)**.
|
||
|
||
| System | Architecture | Packages |
|
||
| --- | --- | --- |
|
||
| Windows 10 1809+ / 11 | x64 | Installer `.exe`, portable `.zip` |
|
||
| Linux Preview, glibc 2.35+ | x64 | `.AppImage`, `.deb`, portable `.tar.gz` |
|
||
| macOS Preview, deployment target 14+ | Apple Silicon / arm64 | `.dmg` |
|
||
| macOS Preview, deployment target 14+ | Intel / x64 | `.dmg` |
|
||
|
||
Package names follow `Pebrel-v<version>-<system>-<architecture>`. Windows offers
|
||
stable installers ending in `-setup.exe` and portable ZIPs. Linux and macOS are
|
||
Preview builds, marked `-preview` before the extension. A legacy-named Windows
|
||
installer is also supplied for older automatic-update clients.
|
||
|
||
On Windows, run the installer or extract the ZIP and launch `pebrel.exe`, keeping
|
||
the bundled directories together. On Linux, install the DEB or make the AppImage
|
||
executable. On macOS, open the matching DMG and drag Pebrel into Applications.
|
||
Ad-hoc-signed macOS builds may require **Open Anyway** in **System Settings >
|
||
Privacy & Security** on first launch. Native macOS CI runs on macOS 15; the
|
||
deployment target alone does not establish validation on every older OS version.
|
||
|
||
Windows currently also provides tray residency, the global quick-terminal hotkey,
|
||
automatic local AI-hook setup, and automatic update installation. These integrations
|
||
are not yet available on Linux or macOS. See [installation details](INSTALL.md) for
|
||
platform requirements and upgrading an existing Nebula installation.
|
||
|
||
## Configure
|
||
|
||
```sh
|
||
pebrel config init --language en-US
|
||
pebrel config check
|
||
```
|
||
|
||
The generated Lua configuration uses `require 'pebrel'` and
|
||
`pebrel.config_builder()`. Invalid reloads retain the last valid configuration.
|
||
See the [Lua configuration guide](docs/lua-configuration.md) for settings and examples.
|
||
|
||
In **Settings → Terminal → Alerts**, **Notification duration** selects **Use defaults**,
|
||
5, 10, 30, or 90 seconds, or **Until dismissed**. The default preserves existing
|
||
lifetimes: short toasts last 5 seconds, message banners 90 seconds, and update
|
||
notices remain until dismissed. The saved preference applies to all newly shown
|
||
or refreshed in-app cards, independently of the AI-toast visibility switch.
|
||
Only the latest three cards are retained; newer cards replace older ones without
|
||
performing their actions, including in persistent mode.
|
||
Hiding a card never approves or rejects a request or changes task state; requests
|
||
remain available in their terminals and updates in Settings. System notifications
|
||
are unchanged. The persisted key is `notification_duration`, with values `default`,
|
||
`5`, `10`, `30`, `90`, or `persistent`.
|
||
See the [notification duration menu](docs/screenshots/notification-duration.png).
|
||
|
||
## Build
|
||
|
||
With the pinned Rust toolchain and the platform dependencies installed:
|
||
|
||
```sh
|
||
cargo build --release --locked -p nebula --bin pebrel --features gpui-shell
|
||
```
|
||
|
||
The internal Cargo package is still named `nebula`; the application and command
|
||
are `pebrel`. GPUI is the product interface. The older renderer is available only
|
||
through the explicit `legacy-shell` feature.
|
||
|
||
## Contact
|
||
|
||
Email: [fickleheartedkeys@163.com](mailto:fickleheartedkeys@163.com)
|
||
|
||
Discord: [discord.gg/VFn4rcxmhn](https://discord.gg/VFn4rcxmhn)
|
||
|
||
## Acknowledgements
|
||
|
||
Pebrel builds on [Alacritty](https://github.com/alacritty/alacritty),
|
||
[GPUI](https://github.com/zed-industries/zed), and
|
||
[gpui-component](https://github.com/longbridge/gpui-component). Terminal text uses
|
||
Maple Mono, and native formulas use Latin Modern Math. Upstream copyright and
|
||
license notices are preserved in `THIRD-PARTY-NOTICES` and `licenses/`.
|
||
|
||
## Community
|
||
|
||
- **[linux.do](https://linux.do)** - A thriving developer community.
|
||
|
||
## ⭐ Star History
|
||
|
||
<a href="https://star-history.com/#Kuddev/pebrel&Date">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Kuddev/pebrel&type=Date&theme=dark" />
|
||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Kuddev/pebrel&type=Date" />
|
||
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Kuddev/pebrel&type=Date" />
|
||
</picture>
|
||
</a>
|