prettiflow 0.15.0

package/README.md

@@ -0,0 +1,90 @@
+# @prettiflow/prettiflow
+
+> The Starting Point for Next-Gen Agents
+
+[![npm](https://img.shields.io/npm/v/@prettiflow/prettiflow)](https://www.npmjs.com/package/@prettiflow/prettiflow) [![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)  [![Docs](https://img.shields.io/badge/docs-online-blue)](https://prettiflow.github.io/prettiflow/en/)
+
+## What is PrettiFlow CLI
+
+PrettiFlow CLI is an AI coding agent that runs in your terminal. It can read and edit code, run shell commands, search files, fetch web pages, and choose the next step based on the feedback it receives. It works out of the box with PrettiFlow's PrettiFlow models and can also be configured to use other compatible providers.
+
+## Install
+
+The recommended install path is the official script. It does not require Node.js to be installed first.
+
+- **macOS / Linux**:
+
+```sh
+curl -fsSL https://code.prettiflow.com/prettiflow/install.sh | bash
+```
+
+- **Windows (PowerShell)**:
+
+```powershell
+irm https://code.prettiflow.com/prettiflow/install.ps1 | iex
+```
+
+> On Windows, install [Git for Windows](https://gitforwindows.org/) before first launch because PrettiFlow CLI uses the bundled Git Bash as its shell environment. If Git Bash is installed in a custom location, set `PRETTIFLOW_SHELL_PATH` to the absolute path of `bash.exe`.
+
+Then run it with a new Terminal session:
+
+```sh
+prettiflow --version
+```
+
+### Alternative: npm
+
+If you prefer npm, use Node.js 22.19.0 or later:
+
+```sh
+npm install -g @prettiflow/prettiflow
+```
+
+Or with pnpm:
+
+```sh
+pnpm add -g @prettiflow/prettiflow
+```
+
+For upgrade and uninstall instructions, see the [Getting Started guide](https://prettiflow.github.io/prettiflow/en/guides/getting-started).
+
+## Quick Start
+
+Open a project and start the interactive UI:
+
+```sh
+cd your-project
+prettiflow
+```
+
+On first launch, run `/login` inside PrettiFlow CLI and choose either PrettiFlow OAuth or a PrettiFlow Platform API key. After login, try a first task:
+
+```
+Take a look at this project and explain the main directories.
+```
+
+## Key Features
+
+- **Single-binary distribution.** Install with one command — no Node.js setup, no PATH gymnastics, no global module conflicts.
+- **Blazing-fast startup.** The TUI is ready in milliseconds, so opening a session never feels heavy.
+- **Polished TUI.** A carefully tuned interface designed for long, focused agent sessions.
+- **Video input.** Drop a screen recording or demo clip into the chat — let the agent watch instead of typing out what's hard to describe in words.
+- **AI-native MCP configuration.** Add, edit, and authenticate Model Context Protocol servers conversationally via `/mcp-config` — no hand-editing JSON.
+- **Subagents for focused, parallel work.** Dispatch built-in `coder`, `explore`, and `plan` subagents in isolated context windows; the main conversation stays clean.
+- **Lifecycle hooks.** Run local commands at key points — gate risky tool calls, audit decisions, fire desktop notifications, wire into your own automation.
+
+## Documentation
+
+- Full docs: https://prettiflow.github.io/prettiflow/en/
+- 中文文档: https://prettiflow.github.io/prettiflow/zh/
+- Getting Started: https://prettiflow.github.io/prettiflow/en/guides/getting-started
+
+## Repository & Issues
+
+- Source: https://github.com/PrettiFlow/prettiflow
+- Issues: https://github.com/PrettiFlow/prettiflow/issues
+- Security: see SECURITY.md in the main repository
+
+## License
+
+MIT