@muyichengshayu/promptx 0.1.11 → 0.1.13

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.1.13
+
+- 加固 Relay 登录链路：登录与管理登录改为 `POST`，并新增登录限流，降低暴力尝试与口令暴露风险。
+- 优化 Relay 相关页面的手机端体验，登录页、管理登录页和统计页在小屏设备上都能更稳定使用。
+- 新建项目后自动选中新项目、关闭弹窗并提示成功，减少新建后的二次操作成本。
+- 编辑区发送按钮补齐三段状态反馈：`发送`、`发送中`、`执行中`，降低“点了没反应”的疑惑。
+- README 中英文版同步精简，把安装、启动、使用方式前置；同时把 Node 版本说明改成更易懂的推荐文案。
+
+## 0.1.12
+
+- Relay 新增按天聚合的租户使用统计，自动记录设备连接与真实转发请求，方便查看“今天有哪些同事实际用了 Relay”。
+- 新增 Relay 管理统计页 `/relay/admin/usage` 与对应接口，可直接查看今日活跃租户、连接次数、请求次数、最近设备与最近活跃时间。
+- 统计能力默认落在云端 Relay 侧，不依赖本地 PromptX client 升级；同时补充文档说明与服务端测试覆盖。
+
 ## 0.1.11
 
 - 加固 Relay 自动重连恢复链路：固定间隔重连升级为指数退避，并在连接成功后重置重连计数，减少 Relay 重启或网络抖动时的无效重试。

package/README.en.md

@@ -2,178 +2,88 @@
 
 [中文 README](README.md)
 
-PromptX is a local AI agent workspace built for long-running coding tasks.
+PromptX is a local AI agent workspace.
 
-It helps `Codex`, `Claude Code`, and `OpenCode` feel less like isolated CLI sessions and more like a structured workflow with better inputs, better outputs, and reusable context.
-
-- Organize requirements, screenshots, notes, `md`, `txt`, and `pdf` before sending
-- Bind each task to a stable project and working directory
-- Review execution logs, final replies, run history, and code diffs in one place
-
-If you already like agent CLIs but want a cleaner way to manage context, review code changes, and continue work across multiple rounds, PromptX is built for that.
+It organizes `Codex`, `Claude Code`, and `OpenCode` into a cleaner workflow:
 
 ```text
 Task -> Project -> Directory -> Thread -> Run -> Diff
 ```
 
-## At A Glance
-
-- Keep using the agent you already prefer: `Codex`, `Claude Code`, or `OpenCode`
-- Let PromptX organize tasks, projects, directories, threads, and run history
-- Prepare context first, then send a better request
-- Review process logs, final output, and code diffs on the same screen
-- Extend from local use to remote access when needed
-
-## What You Get
-
-- A task workspace for ongoing collaboration, not a one-shot prompt box
-- A reusable project layer that keeps the same working directory and agent thread together
-- A persistent run history you can revisit later
-- Built-in diff review for code-generating tasks
-- Remote access options, including self-hosted Relay and an author-hosted service
-
-## Why It Works Well For Codex / Claude Code / OpenCode Users
-
-### Better Input Experience
-
-- Tasks are durable context containers, not temporary prompts
-- You can assemble text, screenshots, imported files, notes, and todos before sending
-- Each task can be bound to a PromptX project, and each project can be bound to a fixed working directory
-- Reuse the same project and thread for the same repo instead of repeating environment setup every round
-- The input area supports text, images, `md`, `txt`, and `pdf`
-
-### Better Output Experience
-
-- Execution logs are visible in the center panel instead of being buried in terminal scrollback
-- Every run keeps its prompt, event log, final reply, and summary
-- Built-in code diff review makes it easier to inspect what the agent actually changed
-- System diagnostics show runner concurrency, queueing, recovery, and stop-related states
-
-### One Workspace For Multiple Engines
-
-- PromptX currently supports `Codex`, `Claude Code`, and `OpenCode`
-- The same task, project, event, and run UI works across all of them
-- More engines can be added without changing the overall workflow
-
-## Screenshots
-
-All screenshots below use the `Glass Light` theme.
-
-### Workspace Overview
-
-Manage tasks on the left, inspect execution in the center, and prepare inputs on the right.
-
-![PromptX workspace overview](docs/assets/readme-workbench-glass.png)
-
-### Execution Focus
-
-Review process logs, turn summaries, and final replies in one continuous view.
-
-![PromptX execution focus](docs/assets/readme-execution-focus-glass.png)
-
-### Code Diff Review
-
-Inspect code changes by workspace, accumulated task history, or a single run.
-
-![PromptX code diff review](docs/assets/readme-diff-glass.png)
-
-### Project Manager
-
-Bind tasks to a fixed project, working directory, and engine so context stays stable.
-
-![PromptX project manager](docs/assets/readme-project-manager-glass.png)
-
-### Remote Relay Settings
-
-Configure remote access directly from the settings panel.
-
-![PromptX relay settings](docs/assets/readme-settings-relay-glass.png)
-
-### Mobile Remote Usage
-
-PromptX can also be accessed remotely on mobile devices, which is a major highlight for many people who want to keep an eye on `Codex`, `Claude Code`, or `OpenCode` runs away from their desk.
-
-![PromptX mobile remote access](docs/assets/readme-mobile-remote-glass.png)
-
-## Core Workflow
-
-### 1. Organize First, Then Send
-
-Instead of dumping a large prompt into the agent immediately, collect the task goal, supporting files, screenshots, logs, and constraints first.
+You keep using the agent CLI you already know, while PromptX brings inputs, project binding, execution logs, final replies, and code diffs into one workspace.
 
-### 2. Bind The Task To A Stable Project
+## Quick Start
 
-Projects keep the working directory and engine session stable, so future rounds do not need the same environment explanation again and again.
+### Requirements
 
-### 3. Review Process, Result, And Diff Together
+- Recommended: `Node 22 LTS`
+- Currently compatible with stable `Node 20 / 22 / 24`
+- At least one supported engine installed locally:
+  - `codex --version`
+  - `claude --version`
+  - `opencode --version`
 
-PromptX makes one run easier to inspect by splitting it into three visible layers:
+### Install
 
-- Process: what the agent did
-- Result: what the agent replied with
-- Diff: what changed in the codebase
-
-### 4. Continue Long Tasks Without Losing Structure
+```bash
+npm install -g @muyichengshayu/promptx
+promptx doctor
+```
 
-Long-running tasks keep their task context, project binding, and run history in place, instead of being scattered across terminal tabs and notes.
+### Start
 
-## Remote Access
+Default URL: `http://127.0.0.1:3000`
 
-PromptX supports full remote access workflows, not just temporary LAN exposure.
+```bash
+promptx start
+promptx status
+promptx stop
+```
 
-You can choose between:
+### How To Use
 
-- Local-only access for personal desktop use
-- Self-hosted Relay on your own server
-- The hosted remote service maintained by the author
+1. Create a task and prepare the context you want to send
+2. Bind the task to a project
+3. Choose a working directory and engine for that project
+4. Send and review execution logs, final replies, and code diffs on the same page
 
-For setup details, see:
+## Core Features
 
-- `docs/relay-quickstart.md`
+- Structured input: text, images, `md`, `txt`, and `pdf`
+- Project reuse: keep a stable directory and engine/thread context
+- Visible process: inspect logs, final replies, and run history
+- Built-in diff review: inspect workspace, accumulated task, or per-run changes
+- Multi-engine support: `Codex`, `Claude Code`, `OpenCode`
+- Remote access: connect from mobile or external networks through Relay
 
-### Self-Hosted Relay
+## Screenshots
 
-Recommended if you want full control over your own domain, data flow, and access strategy.
+### Workspace
 
-- Good for users with a server and basic ops knowledge
-- Suitable for personal long-term use or small internal teams
-- Current docs already cover startup, tenants, domains, Nginx, and troubleshooting
+![PromptX workspace](docs/assets/workbench-overview.jpg)
 
-### Author-Hosted Remote Service
+### Settings
 
-If you do not want to deploy your own Relay, the author is already running a hosted remote service.
+![PromptX settings](docs/assets/settings-panel.jpg)
 
-- Good for trying remote PromptX quickly
-- Good for users who want mobile access without self-hosting first
-- Limited seats are available; contact the author if you want an account
+### Mobile
 
-This hosted option is best treated as a convenience offering. If you need long-term guaranteed capacity, self-hosting is still the better path.
+![PromptX mobile](docs/assets/mobile-remote.jpg)
 
-## Best Use Cases
+## Why It Helps
 
-- Prepare requirements, screenshots, and docs before sending a coding task
-- Reuse the same working directory and thread across many rounds
-- Review execution logs, final output, and code changes together
-- Access PromptX remotely from a phone or another device
-- Run PromptX on a remote machine for always-on personal usage
+- Keeps long-running tasks out of scattered terminal tabs and notes
+- Avoids re-explaining directories, projects, and context every round
+- Lets you review process and result together, not just the final answer
+- Makes code review easier with built-in diff inspection
+- Keeps tasks accessible on mobile when you are away from your desk
 
-## Installation
+## Good Fit For
 
-```bash
-npm install -g @muyichengshayu/promptx
-promptx doctor
-```
-
-## Start
-
-Default URL: `http://127.0.0.1:3000`
-
-```bash
-promptx start
-promptx status
-promptx stop
-promptx relay start
-```
+- Preparing requirements, screenshots, logs, and files before sending
+- Reusing the same project and directory across many rounds
+- Reviewing execution logs, final output, and code changes together
+- Exposing local PromptX to phones or external networks through Relay
 
 ## Development
 
@@ -190,26 +100,42 @@ Workspace structure:
 - `apps/runner`: standalone runner process
 - `packages/shared`: shared constants and event protocol
 
-Screenshot generator used for the README:
+## Remote Access
+
+For Relay setup, see:
 
-- `scripts/capture-readme-screenshots.mjs`
+- `docs/relay-quickstart.md`
 
-## Supported Engines
+That guide covers:
 
-- `Codex`
-- `Claude Code`
-- `OpenCode`
+- Connecting a local PromptX client to Relay
+- Starting and managing Relay on a server
+- Multi-tenant subdomain setup
+- `promptx relay tenant add/list/remove`
+- `promptx relay start/stop/restart/status`
 
-Related docs:
+## Zentao Extension
 
-- `docs/agent-run-protocol.md`
-- `docs/relay-quickstart.md`
+The repository includes a Zentao Chrome extension at `apps/zentao-extension`.
+
+Notes:
+
+- The published npm package does not include this extension directory
+- If you need it, clone the repo and load it manually
+
+Steps:
+
+1. Open `chrome://extensions`
+2. Enable developer mode
+3. Click “Load unpacked”
+4. Select `apps/zentao-extension`
 
 ## Notes
 
 - PromptX is currently optimized for local-first, mostly single-user workflows
 - Different engines may expose different tool capabilities and event richness
-- Restricted engine permissions will directly affect file edits, command execution, and automation
+- Use Relay if you need cross-device access
+- Runtime data is stored under `~/.promptx/`
 
 ## License