Skip to content

Commit 901bf7b

Browse files
authored
Refresh README for public development
Adds public CI and license badges, current Pi recovery documentation, source-build onboarding, and analytics privacy details.
1 parent 35dd84a commit 901bf7b

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# PiNative
22

3+
[![CI](https://github.com/Unsupervisedcom/pi-native/actions/workflows/ci.yml/badge.svg)](https://github.com/Unsupervisedcom/pi-native/actions/workflows/ci.yml)
4+
[![UI Tests](https://github.com/Unsupervisedcom/pi-native/actions/workflows/ui-tests.yml/badge.svg)](https://github.com/Unsupervisedcom/pi-native/actions/workflows/ui-tests.yml)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
6+
37
PiNative is a native macOS GUI for [Pi](https://pi.dev), the terminal coding-agent harness. It keeps Pi as the agent runtime and process engine, then replaces the terminal interface with a polished SwiftUI shell: project sidebar, persistent chat sessions, native transcript rendering, model selection, pending-change review, and a compose experience designed to feel at home on macOS.
48

59
This repository includes the app, its observable requirements, and implementation documentation for the current architecture.
@@ -23,6 +27,7 @@ That means:
2327
- **Projects and Quick Chats** — organize chats under local project folders or start projectless, planning-only conversations from the Quick Chats section.
2428
- **Parallel chat runtimes** — keep multiple conversations working independently, each with its own Pi process, transcript, draft, loading state, and scoped Stop control.
2529
- **Durable sessions** — restore project/chat metadata and cached transcripts immediately across launches, then reconcile them with Pi's canonical session history.
30+
- **Pi health and recovery** — discover Pi across shell and package-manager installations, validate startup readiness, and offer an actionable Terminal recovery flow when installation, setup, or authentication needs attention.
2631
- **Rich native composer** — send text, pasted or dropped images, and file references; choose the active model and effort level without leaving the chat.
2732
- **Promote to Project** — turn a Quick Chat into a guarded project folder with generated context and provenance, then continue in a new project-scoped handoff chat.
2833
- **Fast native navigation** — use project and chat rows, pinning, archiving/restoration, command-number shortcuts, and responsive hover controls designed for macOS.
@@ -41,6 +46,9 @@ node scripts/serve-code-architecture-walkthrough.mjs
4146

4247
## Installation
4348

49+
> [!NOTE]
50+
> PiNative is under active development and does not yet have a packaged public release. Build it from source using the steps below.
51+
4452
### Requirements
4553

4654
- A Mac running macOS 14 or newer.
@@ -86,7 +94,11 @@ In practice, install Pi normally and confirm `pi --mode rpc` works in Terminal b
8694

8795
### Build from the command line
8896

97+
Clone the public repository, then build the app:
98+
8999
```sh
100+
git clone https://github.com/Unsupervisedcom/pi-native.git
101+
cd pi-native
90102
xcodebuild -project PiNative.xcodeproj -scheme PiNative \
91103
-configuration Debug -destination 'platform=macOS' build
92104
```
@@ -136,6 +148,12 @@ scripts/test-ui-related.sh
136148

137149
For the full requirements workflow, CI behavior, UI-suite differences, and live-Pi smoke-test notes, see [Requirements and Testing](docs/requirements-and-testing.md).
138150

151+
## Privacy and analytics
152+
153+
Official builds can include optional product analytics and sanitized failure diagnostics. Analytics events use an explicit allowlist and do not include prompts, responses, file paths, session IDs, project names, attachments, provider/model selections, account details, or raw error messages. Automatic exception and crash capture is disabled.
154+
155+
You can turn off **Product analytics** at any time in **Settings → General**. Builds without a configured PostHog project token do not send analytics.
156+
139157
## Documentation
140158

141159
- [`docs/code-architecture-walkthrough.html`](docs/code-architecture-walkthrough.html) — visual, source-linked architecture tour.

0 commit comments

Comments
 (0)