pi-cloud 2.0.0

package/.env.example

@@ -0,0 +1,115 @@
+# =============================================================================
+# Server
+# =============================================================================
+
+# Backend bind address and port.
+# For public deployments behind nginx, keep HOST bound to localhost.
+HOST=127.0.0.1
+PORT=3000
+
+# Frontend development server port.
+FRONTEND_PORT=5173
+
+# =============================================================================
+# Authentication and sessions
+# =============================================================================
+
+PI_CLOUD_AUTH_USERNAME=yourname
+
+# Development or simple setups only. Prefer PI_CLOUD_AUTH_PASSWORD_HASH in production.
+PI_CLOUD_AUTH_PASSWORD=change-me-for-dev-only
+# PI_CLOUD_AUTH_PASSWORD_HASH=$scrypt$ln=15,r=8,p=3$...
+
+# Active sessions renew before the idle timeout, up to the absolute maximum lifetime.
+PI_CLOUD_SESSION_TTL_HOURS=8
+PI_CLOUD_SESSION_MAX_HOURS=720
+
+# Set true only when the app is served exclusively over HTTPS.
+PI_CLOUD_COOKIE_SECURE=false
+
+# Enable only when requests always pass through a trusted reverse proxy.
+PI_CLOUD_TRUST_PROXY=false
+
+# Emergency 2FA recovery only. Keep false during normal operation.
+SKIP_2FA_VERIFY=false
+
+
+# =============================================================================
+# Storage, filesystem, and terminal
+# =============================================================================
+
+# Custom SQLite database path. Defaults to the user configuration directory.
+# PI_CLOUD_DB_PATH=/home/youruser/.config/pi-cloud/pi-cloud.sqlite
+
+# Comma-separated directories the file browser and terminal may access.
+# Defaults to the current user's home directory.
+# PI_CLOUD_ALLOWED_ROOTS=/home/youruser/git/github,/home/youruser/projects
+
+# Disable allowed-root checks. Defaults to true on Windows and false on macOS/Linux.
+# PI_CLOUD_DISABLE_PATH_CHECK=false
+
+# Allow "Open with system tool" through non-localhost URLs, such as a local nginx hostname.
+# This launches applications on the machine running Pi Cloud.
+PI_CLOUD_ENABLE_SYSTEM_OPEN=false
+
+# Terminal shell executable, such as powershell.exe, pwsh.exe, or /bin/zsh.
+# PI_CLOUD_TERMINAL_SHELL=pwsh.exe
+
+# Memory extraction/recall policy. Defaults to adaptive-lexical-v1; use legacy to roll back.
+# PI_CLOUD_MEMORY_POLICY=legacy
+
+
+# =============================================================================
+# AI providers
+# =============================================================================
+
+# Comma-separated exact origins permitted for non-loopback local LLM endpoints.
+# Loopback endpoints are allowed by default.
+# PI_CLOUD_LOCAL_LLM_ALLOWED_ORIGINS=http://192.168.1.20:11434,https://llm.example.test
+
+# Provider API keys (uncomment as needed).
+# ANTHROPIC_API_KEY=sk-ant-...
+# OPENAI_API_KEY=sk-...
+# GEMINI_API_KEY=...
+# DEEPSEEK_API_KEY=...
+# GROQ_API_KEY=...
+# XIAOMI_API_KEY=...
+
+# Azure OpenAI.
+# AZURE_OPENAI_BASE_URL=https://your-resource.openai.azure.com
+# AZURE_OPENAI_API_VERSION=v1
+
+# AWS Bedrock.
+# AWS_REGION=us-east-1
+# AWS_PROFILE=default
+
+
+# =============================================================================
+# Messaging gateways
+# =============================================================================
+
+# Optional shared gateway defaults.
+# Configure profile, skillset, model, and allowed folders in Settings > Gateway.
+# PI_CLOUD_GATEWAY_COMMAND_PREFIX=小助理
+
+# Feishu/Lark callback.
+# Event subscription URL: https://your-domain/api/gateways/feishu/events
+# PI_CLOUD_FEISHU_APP_ID=cli_xxx
+# PI_CLOUD_FEISHU_APP_SECRET=xxx
+# Verification token is required; encrypt key is required for encrypted callbacks.
+# PI_CLOUD_FEISHU_VERIFICATION_TOKEN=xxx
+# PI_CLOUD_FEISHU_ENCRYPT_KEY=xxx
+# PI_CLOUD_FEISHU_DOMAIN=feishu
+
+# WeChat/Weixin (Tencent iLink long-polling, text DMs).
+# Disabled by default; enabling it requires an account ID and token.
+PI_CLOUD_WECHAT_GATEWAY_ENABLED=false
+# PI_CLOUD_WECHAT_ACCOUNT_ID=your-account-id
+# PI_CLOUD_WECHAT_TOKEN=your-bot-token
+# PI_CLOUD_WECHAT_BASE_URL=https://ilinkai.weixin.qq.com
+
+# DM policies: pairing, allowlist, open, or disabled.
+# PI_CLOUD_WECHAT_DM_POLICY=pairing
+# PI_CLOUD_WECHAT_ALLOWED_USERS=user_id_1,user_id_2
+# Required only when PI_CLOUD_WECHAT_DM_POLICY=open.
+# PI_CLOUD_WECHAT_ALLOW_ALL_USERS=false

package/CHANGELOG.md

@@ -0,0 +1,177 @@
+# Changelog
+
+All notable changes to Pi Cloud are documented here.
+
+## [2.0.0] - 2026-08-30
+
+### Added
+
+- Added persistent PDF annotations with drawing, highlighting, shapes, text, moving, erasing, undo/redo, automatic sidecar saving, and annotated PDF export.
+- Added Markdown-to-PDF downloads and creation of workspace PDF copies that can be annotated.
+- Added custom OpenAI-compatible API providers and Cloudflare Workers AI support, including model discovery and image-capability selection.
+- Added provider authentication status and disconnect controls for locally detected API keys, OAuth sessions, and subscriptions.
+- Added Markdown preview outlines, HTML rendering in Markdown previews, archive content previews, file-type icons, and full-path copying from editor tabs.
+- Added light/dark theme toggle controls and PDF viewport fit controls.
+- Added split diff views, collapsible files, per-file statistics, and expand/collapse controls to commit previews and Git history.
+- Added WeChat account unbinding and country reporting for successful proxy checks.
+- Added a preference to delete sessions without confirmation and reload recovery for stale frontend assets after updates.
+
+### Changed
+
+- Renamed Pi WebUI to Pi Cloud, changing the npm package and executable to `pi-cloud`, environment variables to the `PI_CLOUD_` prefix, and default configuration, database, and service names and paths.
+- Recent project history is now stored per agent profile in the server database instead of browser storage.
+- PDF previews now render only nearby pages for improved performance.
+
+### Fixed
+
+- Fixed PDF annotation resize handles so dragging them resizes annotations correctly.
+- Hid built-in API-key providers when a custom provider with the same ID overrides them.
+- Fixed session sidebar message counts and stale-asset reload errors.
+
+## [1.0.6] - 2026-08-27
+
+### Added
+
+- Added a paginated Git history viewer with commit metadata, change statistics, and per-file diffs.
+- Added PDF previews in the editor with page navigation and zoom controls.
+
+### Changed
+
+- The Git changes panel now identifies non-repository folders and disables unavailable Git actions instead of showing a Git command error.
+
+### Fixed
+
+- Fixed published npm package dependency metadata to use resolvable versions instead of pnpm catalog references.
+- Prevented the `Ctrl+E` editor shortcut from also triggering keyboard handlers on selected messages.
+
+## [1.0.5] - 2026-08-27
+
+### Added
+
+- Added a Git changes panel, shown by default, with changed-file navigation, per-file diffs, and shortcuts for common Git actions.
+- Added collapsible pin groups for organizing, moving, and unpinning agent-profile and review-source sessions.
+- Added a project history tab with last-accessed details, session counts, and confirmed removal of saved session history without deleting project files.
+- Added an option to generate commit messages from and commit only staged changes.
+- Added `PI_CLOUD_ENABLE_SYSTEM_OPEN` for enabling **Open with system tool** through trusted non-localhost URLs.
+
+### Changed
+
+- Reduced the initial session page from 30 sessions to 10 and limited pull request status refreshes to the visible page for faster session loading.
+- Lazy-load heavy interface features such as the editor, terminal, settings, memory center, and task queue.
+- Local LLM endpoints outside the loopback interface must now be explicitly allowed with `PI_CLOUD_LOCAL_LLM_ALLOWED_ORIGINS`; endpoint credentials and redirects are rejected.
+- Database schema updates now use tracked, transactional versioned migrations.
+
+### Fixed
+
+- Ensured newly created sessions use the explicitly selected agent profile.
+- Improved virtual diff formatting with clearer file headers and correct multi-file navigation and line tracking.
+- Hardened path validation for session relocation and project moves, and stopped the file tree from traversing symlinked directories.
+- Hardened URL and rendered HTML handling, including host validation, heading sanitization, and attribute escaping.
+- Open files safely on Windows without invoking a shell.
+
+## [1.0.4] - 2026-08-23
+
+### Added
+
+- Added local LLM endpoint and model discovery/configuration, plus removal controls for local LLM settings and stored API keys.
+- Added unified and split diff views, multi-file diff tabs and navigation, and GitHub-style diff coloring in the editor.
+- Added clickable commit references in chat that open the corresponding commit diff in the editor.
+- Added a resizable message input for review sessions.
+- Added persistent skill preset references for queued tasks.
+
+### Changed
+
+- Pinned memories now default to applying only when matched to the current prompt.
+
+### Fixed
+
+- Enabled word wrapping for virtual diffs.
+- Corrected directory sort toggle labels in the folder picker.
+
+## [1.0.3] - 2026-08-19
+
+### Added
+
+- Added review-session integrations for Devin, Claude Code, and Codex, with source configuration, session search, and transcript viewing.
+- Added secure HTML file previews with sandboxing and support for local page assets.
+- Added new-folder creation to the folder picker.
+- Added an action to move saved sessions to another folder.
+
+### Changed
+
+- Improved review transcript rendering, including tool-call details, patch display, output indentation, and PDF export.
+
+### Fixed
+
+- Wait for the chat connection before starting tasks in newly opened tabs.
+- Select the correct review session from the compact session rail.
+- Normalize terminal progress output before rendering tool results.
+- Normalize Windows file paths across file links, the editor, and file-tree navigation.
+- Prefer the `origin` remote when resolving GitHub or Gitea integrations, while falling back to other matching remotes.
+
+## [1.0.2] - 2026-08-16
+
+### Added
+
+- Added global and per-project prompt customization for AI-generated Git commit messages.
+- Added a shallow-clone option when cloning repositories.
+- Added Mermaid diagram rendering to the Markdown preview.
+- Added modified-time sorting to the folder picker and file tree.
+- Added `pi-cloud --version` and `pi-cloud -v` commands.
+
+### Changed
+
+- Generate the complete sample configuration with random login credentials on the first run of a global installation.
+- Replaced Argon2 password hashing with Node.js's built-in scrypt implementation, removing the native Argon2 dependency.
+- Added a favicon to the project website.
+
+### Fixed
+
+- Stop panel resize interactions when the browser window loses focus.
+- Include `CHANGELOG.md` in the npm package so the changelog remains available in global installations.
+
+## [1.0.1] - 2026-08-15
+
+### Added
+
+- Added a responsive GitHub Pages website with an illustrated feature guide, updated product screenshots, and automated deployment.
+- Added `pi-cloud service restart` support on Linux, macOS, and Windows.
+
+### Changed
+
+- Always use Pi Cloud's bundled session auto-rename extension instead of disabling it when an external auto-rename plugin is detected.
+- Upgraded `better-sqlite3` from version 12 to 13 and removed the deprecated `prebuild-install` dependency.
+- Added a GitHub social preview image and refreshed the main interface screenshots.
+
+### Fixed
+
+- Respect `PORT` and `HOST` values from `~/.config/pi-cloud/.env` when the CLI starts Pi Cloud, while preserving explicit CLI option precedence.
+- Open home-relative (`~/`) file links from chat in the editor instead of resolving them against the workspace.
+- Open relative links and heading anchors within the Markdown preview instead of navigating to browser routes.
+- Improved user-message link contrast and hover/focus visibility in the light theme.
+- Allow the GitHub Pages workflow to enable Pages during deployment.
+
+## [1.0.0] - 2026-07-23
+
+### Added
+
+- **Packaging and deployment** — install with the `pi-cloud` executable, run from source, deploy behind a reverse proxy, and use Apache-2.0 licensing.
+- **Authentication** — protect the WebUI with password/TOTP authentication, renewable sessions, absolute session lifetime, and production cookie settings.
+- **Settings** — manage model defaults, automation model, shortcuts, gateway profiles, skillsets, Git hosting, and session launch preferences.
+- **Workspace tools** — browse files, search workspace paths with `@`, edit code with Monaco, and use an embedded xterm terminal.
+- **Streaming chat** — receive real-time Pi responses over WebSocket with reconnect support, thinking/details controls, and local command result messages.
+- **Session management** — create, resume, rename, compact, summarize, inspect, branch, and navigate session trees from the WebUI.
+- **Multi-tab support** — run independent sessions per browser tab/client.
+- **Model selection** — inspect and change the active model for a session.
+- **Chat composer enhancements** — attach images to chat messages, polish prompts with AI, and choose model/thinking level directly from the composer.
+- **Slash commands** — use built-in commands for Git, sessions, models, skills, summaries, changelog display, and Pi-discovered skill/prompt commands.
+- **Git workflows** — inspect diff/status, create branches, commit, amend, push, pull, open read-only diffs, remember branch selections per project, and generate AI branch names.
+- **Git hosting workflows** — configure Git hosting, create issues and pull requests, check proxies, preserve configured repository ports, and surface pull request status in the session UI.
+- **Pull request authoring** — preview pull requests, generate PR titles and descriptions, push branches, and create PRs from `/pr`.
+- **Project onboarding** — clone repositories from the project picker and open projects or queued tasks in new tabs.
+- **Worktree development** — create inherited worktree sessions for isolated implementation work while preserving the source session context.
+- **Skill preset management** — configure enabled and disabled skills per session, refresh slash-command suggestions after changes, and use `skill:<name>` commands directly from chat.
+- **Memory system** — manage project and global memories with automatic extraction, adaptive recall, recall details, and reusable remembered context.
+- **Task queue and notifications** — queue project tasks, edit tasks, start pending work, track task state, and configure sound notifications.
+- **Gateway integrations** — add Feishu and WeChat gateway support, including pairing, messaging, command aliases, centralized gateway settings, and WeChat image ingestion/decryption.
+- **Agent proxy configuration** — configure proxy environment variables per Pi profile for model/agent traffic.

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 xianzhon
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,134 @@
+# Pi Cloud
+
+English | [简体中文](README.zh-CN.md)
+
+A web-based, mobile-friendly interface for the [Pi coding agent](http://pi.dev). It complements the terminal-first CLI with a persistent workspace for agent sessions and development workflows.
+
+| Dark theme                                                                    | Light theme                                                                     |
+| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| ![Pi Cloud main window in dark theme](docs/images/main-window-dark-theme.png) | ![Pi Cloud main window in light theme](docs/images/main-window-white-theme.png) |
+
+**[▶ Watch Pi Cloud handle a Git bugfix workflow](https://xianzhon.github.io/pi-cloud-website/assets/videos/demo-git-bugfix-workflow.mp4)**
+
+## Features
+
+- **Mobile-friendly access** — use Pi from a desktop, phone, or tablet without needing a local terminal.
+- **Skill control** — configure presets and enable or disable skills per session.
+- **Session management** — search, resume, rename, branch, and run independent sessions in separate tabs.
+- **Task queue** — save and configure tasks, then start them when ready.
+- **Completion notifications** — receive a sound alert and see a bell indicator in the browser tab when a task finishes.
+- **AI-assisted writing** — generate or polish prompts, commit messages, pull request content, and other workflow text.
+- **Git workflows** — use `/branch`, `/commit`, `/push`, and related commands from the WebUI.
+- **GitHub and Gitea integration** — review changes and create pull requests with `/pr`.
+- **Memory support** — maintain project and global memories with optional automatic extraction and adaptive recall.
+- **Messaging gateways** — connect Feishu and WeChat through a focused setup.
+- **Workspace tools** — browse and search files, edit code, and use an embedded terminal alongside the conversation.
+- **Secure access** — protect the WebUI with password and optional TOTP authentication.
+
+## Quick Start
+
+### Prerequisites
+
+- Node.js 22 or newer
+- pnpm 9 or newer (source development only)
+
+Pi Cloud includes the [Pi coding agent](http://pi.dev), so a separate `pi` installation is not required when using API-key authentication. API keys can be configured from the agent profile dialog.
+
+OAuth subscription sign-in is not currently available in the WebUI; native OAuth support is a planned future improvement. For now, install the standalone Pi CLI and complete `/login` in the terminal as the same OS user that runs Pi Cloud:
+
+```bash
+npm install -g --ignore-scripts @earendil-works/pi-coding-agent
+pi
+# Enter /login and select a provider
+```
+
+Pi Cloud then detects the OAuth credentials stored in the default `~/.pi/agent` profile.
+
+### Run without installing
+
+If npm fails while building native dependencies, install system build tools such as `build-essential` and `python3`, then retry.
+
+Set login credentials, then run the latest release:
+
+```bash
+PI_CLOUD_AUTH_USERNAME=pi PI_CLOUD_AUTH_PASSWORD='change-this-password' npx pi-cloud@latest
+```
+
+Open http://127.0.0.1:3000. The CLI opens the browser automatically after the server is ready.
+
+### Install globally
+
+```bash
+npm install -g pi-cloud
+pi-cloud
+```
+
+On first run, Pi Cloud creates a protected configuration file with username `admin` and prints a randomly generated password once.
+
+See the [Configuration Manual](docs/manuals-en/configuration.md) to customize credentials, ports, and other settings. For remote or public access, see the [Deployment Manual](docs/manuals-en/deployment.md).
+
+### Run as a system service
+
+Install Pi Cloud as a startup service on Linux, macOS, or Windows:
+
+```bash
+pi-cloud service install
+pi-cloud service status
+```
+
+On Windows, antivirus software may block `pi-cloud service install` because it creates an automatic-start scheduled task. Review the antivirus detection before allowing it; do not disable antivirus or exclude the entire npm directory.
+
+### Run from source
+
+```bash
+git clone https://github.com/xianzhon/pi-cloud && cd pi-cloud
+pnpm install
+cp .env.example .env    # set PI_CLOUD_AUTH_USERNAME and PI_CLOUD_AUTH_PASSWORD
+pnpm dev
+```
+
+Open http://localhost:5173 during development. The production server listens on `PORT` (default `3000`).
+
+## Configuration
+
+The essential settings are:
+
+| Variable                   | Description                          |
+| -------------------------- | ------------------------------------ |
+| `PI_CLOUD_AUTH_USERNAME` | Login username                       |
+| `PI_CLOUD_AUTH_PASSWORD` | Login password for a simple setup    |
+| `PORT`                   | Backend port (default:`3000`)      |
+| `HOST`                   | Bind address (default:`127.0.0.1`) |
+
+For production, use `PI_CLOUD_AUTH_PASSWORD_HASH` instead of a plaintext password. See the [Configuration Manual](docs/manuals-en/configuration.md) for configuration files, security, session, storage, workspace, memory, provider, and gateway settings.
+
+## Deployment
+
+See the [Deployment Manual](docs/manuals-en/deployment.md) for source and npm package deployments, plus nginx reverse proxy configuration.
+
+## Documentation
+
+Browse the [documentation index](docs/README.md) for all user manuals and developer references.
+
+## Development
+
+```bash
+pnpm dev                  # start both servers
+pnpm build                # typecheck + bundle both
+pnpm test                 # run all tests
+```
+
+- Frontend: http://localhost:5173 (Vite, proxies `/api` and `/ws` to backend)
+- Backend: http://localhost:3000 (Fastify)
+- Logs: `.logs/`
+- PIDs: `.pids/`
+
+For architecture, API, local package testing, and project layout notes, see [Developer Notes](docs/to-developers/developer-notes.md).
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, branch and pull request conventions, testing, documentation requirements, and security reporting.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for details.