Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 19 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,22 +58,16 @@ limitations.
For the complete Windows checklist, use
[Windows first run](docs/windows-first-run.md).

## Chronicle Comparison
## Relationship To Codex Chronicle

For official Codex Chronicle behavior, see the
[OpenAI Chronicle documentation](https://developers.openai.com/codex/memories/chronicle).
WinChronicle should not be read as a promise to match that product surface.
WinChronicle is independent from OpenAI and is not an official Chronicle clone.
Official Codex Chronicle is a Codex-native macOS research preview; WinChronicle
is a Windows-first open-source layer built around UIA metadata, local storage,
deterministic reports, and read-only MCP. See the
[project presentation checklist](docs/project-presentation.md) for copyable
positioning and comparison language.

| Area | Official Codex Chronicle | WinChronicle |
| --- | --- | --- |
| Platform | Opt-in Codex app research preview on macOS. | Windows-first open-source project. |
| Default context source | Recent screen context, with macOS Screen Recording and Accessibility permissions. | Microsoft UI Automation structured context through deterministic fixtures, explicit helper/watcher previews, and finite monitor sessions. |
| Codex-native memory integration | Augments Codex memories from recent screen context. | Does not write official Codex memories by default; produces local captures, SQLite search, deterministic Markdown memory, and read-only MCP context. |
| Default screenshot/OCR behavior | Official docs describe selected screenshot frames and OCR text as possible inputs to memory generation. | Screenshots and OCR are not implemented as the baseline and remain off by default. |
| Local storage | Official docs describe temporary local screen captures and local generated Markdown memories. | Stores local state under `%LOCALAPPDATA%\WinChronicle` by default, or `WINCHRONICLE_HOME` for isolated demos/tests. |
| MCP interface | Not presented as the primary Chronicle interface in the official docs. | Exposes a fixed read-only MCP tool list for local context. |
| Desktop control | Chronicle is described as a memory/context feature, not a desktop-control API. | No desktop control, click, type, keypress, clipboard, screenshot, OCR, audio, network, file-write, or MCP write tools. |
| Privacy posture | Opt-in preview with explicit warnings about sensitive screen content and prompt injection risk. | Privacy/redaction-first baseline: observed content is untrusted, secrets are redacted before storage/search/memory/MCP, and capture-surface expansion requires human approval. |
The detailed comparison covers Platform, Default context source, Codex-native memory integration, Default screenshot/OCR behavior, Local storage, MCP interface, Desktop control, and Privacy posture without making those fields the first screen.

## Recommended Codex Usage

Expand Down Expand Up @@ -281,31 +275,21 @@ maintenance loop automatically.
- Improve local report readability without adding screenshots, OCR, upload, or
desktop-control behavior.

<!--
Compatibility-contract references kept out of the rendered navigation list:
[Operator quickstart](docs/operator-quickstart.md), [v0.1 closure note](docs/goal-closure-v0.1.md), [Deterministic demo](docs/deterministic-demo.md), [Workday session](docs/workday-session.md), [Manual smoke evidence ledger](docs/manual-smoke-evidence-ledger.md), [Read-only MCP examples](docs/mcp-readonly-examples.md), [Agent context eval scaffold](benchmarks/evals/README.md), [Windows developer app compatibility](docs/windows-developer-app-compatibility.md), [Watcher preview](docs/watcher-preview.md), [Contributing](CONTRIBUTING.md).
-->

## Key Docs

- [Windows first run](docs/windows-first-run.md)
- [5-minute demo](docs/quick-demo.md)
- [Why WinChronicle](docs/why-winchronicle.md)
- [Codex App workday guide](docs/codex-app-workday-guide.md)
- [MCP client setup](docs/mcp-client-setup.md)
- [Privacy architecture](docs/privacy-architecture.md)
- [Operator quickstart](docs/operator-quickstart.md)
- [Roadmap](docs/roadmap.md)
- [v0.1 closure note](docs/goal-closure-v0.1.md)
- [Known limitations](docs/known-limitations.md)
- [Deterministic demo](docs/deterministic-demo.md)
- [v0.2 monitor session](docs/v0.2-monitor-session.md)
- [Windows first run](docs/windows-first-run.md)
- [Workday session](docs/workday-session.md)
- [Workday summary example](docs/examples/workday-summary.en.md)
- [Codex App local plugin install](docs/codex-app-plugin-install.md)
- [Codex App workday guide](docs/codex-app-workday-guide.md)
- [Codex workday plugin](docs/codex-workday-plugin.md)
- [Project presentation checklist](docs/project-presentation.md)
- [v0.2.0 release record](docs/release-v0.2.0.md)
- [Manual smoke evidence ledger](docs/manual-smoke-evidence-ledger.md)
- [MCP client setup](docs/mcp-client-setup.md)
- [Read-only MCP examples](docs/mcp-readonly-examples.md)
- [Agent context eval scaffold](benchmarks/evals/README.md)
- [Windows app compatibility](docs/windows-app-compatibility.md)
- [Windows developer app compatibility](docs/windows-developer-app-compatibility.md)
- [Watcher preview](docs/watcher-preview.md)
- [Maintenance and release history index](docs/maintenance-index.md)
- [Contributing](CONTRIBUTING.md)

Historical audit, sweep, readiness, and release records remain reachable through
the maintenance index instead of the README.
54 changes: 19 additions & 35 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,16 @@ AI 编程 Agent 如果能理解用户当前工作流,会更有用;但屏幕

完整 Windows 清单见 [Windows 首次运行](docs/windows-first-run.md)。

## 与官方 Codex Chronicle 的差异
## Codex Chronicle 的关系

官方 Codex Chronicle 的行为以
[OpenAI Chronicle documentation](https://developers.openai.com/codex/memories/chronicle)
为准。不要把 WinChronicle 理解成已经具备官方 Chronicle 的全部能力。
WinChronicle 独立于 OpenAI,也不是官方 Chronicle 的克隆。官方 Codex Chronicle
是 Codex-native 的 macOS research preview;WinChronicle 是
Windows-first 开源层,重点是 UIA metadata、本地存储、确定性报告和只读 MCP。
可复制的项目介绍和对比措辞见
[Project presentation checklist](docs/project-presentation.md)。

| 项目 | 官方 Codex Chronicle | WinChronicle |
| --- | --- | --- |
| 平台 | Codex app 中的 opt-in macOS research preview。 | Windows-first 开源项目。 |
| 默认上下文来源 | 近期 screen context,需要 macOS Screen Recording 和 Accessibility 权限。 | Microsoft UI Automation 结构化上下文,来自确定性 fixtures、显式 helper/watcher preview 和有限 monitor session。 |
| Codex 原生记忆集成 | 用近期 screen context 增强 Codex memories。 | 默认不写入官方 Codex memories;生成本地 captures、SQLite 搜索、确定性 Markdown memory 和只读 MCP context。 |
| 默认截图/OCR 行为 | 官方文档说明 memory generation 可能处理 selected screenshot frames 和 OCR text。 | baseline 不实现截图和 OCR,且默认保持关闭。 |
| 本地存储 | 官方文档说明会有临时本地 screen captures 和本地生成的 Markdown memories。 | 默认存储在 `%LOCALAPPDATA%\WinChronicle`,demo/test 可用 `WINCHRONICLE_HOME` 隔离。 |
| MCP 接口 | 官方文档没有把外部 MCP server 作为 Chronicle 的主要接口。 | 暴露固定的只读 MCP tools,用于本地上下文读取。 |
| 桌面控制 | Chronicle 被描述为 memory/context feature,不是 desktop-control API。 | 不提供桌面控制、点击、输入、按键、剪贴板、截图、OCR、音频、网络、文件写入或 MCP 写工具。 |
| 隐私姿态 | opt-in preview,并明确提示 sensitive screen content 和 prompt injection 风险。 | privacy/redaction-first baseline:observed content 不可信,secrets 在 storage/search/memory/MCP 前脱敏,capture-surface 扩展需要人类批准。 |
详细对比覆盖:平台、默认上下文来源、Codex 原生记忆集成、默认截图/OCR 行为、
本地存储、MCP 接口、桌面控制和隐私姿态;这些字段不再占据 README 首屏。

## Recommended Codex usage / 推荐的 Codex 使用方式

Expand Down Expand Up @@ -257,31 +251,21 @@ session,同时继续把截图、OCR、音频、键盘、剪贴板、云上传
- 为新的 token canaries 增加 redaction tests。
- 改进本地 report 可读性,但不要增加截图、OCR、上传或桌面控制行为。

<!--
Compatibility-contract references kept out of the rendered navigation list:
[Operator quickstart](docs/operator-quickstart.md)、[v0.1 closure note](docs/goal-closure-v0.1.md)、[Deterministic demo](docs/deterministic-demo.md)、[Workday session](docs/workday-session.md)、[Manual smoke evidence ledger](docs/manual-smoke-evidence-ledger.md)、[Read-only MCP examples](docs/mcp-readonly-examples.md)、[Agent context eval scaffold](benchmarks/evals/README.md)、[Windows developer app compatibility](docs/windows-developer-app-compatibility.md)、[Watcher preview](docs/watcher-preview.md)、[Contributing](CONTRIBUTING.md)。
-->

## 关键文档

- [Windows 首次运行](docs/windows-first-run.md)
- [5-minute demo](docs/quick-demo.md)
- [Why WinChronicle](docs/why-winchronicle.md)
- [Codex App 工作日指南](docs/codex-app-workday-guide.md)
- [MCP client setup](docs/mcp-client-setup.md)
- [Privacy architecture](docs/privacy-architecture.md)
- [Operator quickstart](docs/operator-quickstart.md)
- [Roadmap](docs/roadmap.md)
- [v0.1 closure note](docs/goal-closure-v0.1.md)
- [Known limitations](docs/known-limitations.md)
- [Deterministic demo](docs/deterministic-demo.md)
- [v0.2 monitor session](docs/v0.2-monitor-session.md)
- [Windows 首次运行](docs/windows-first-run.md)
- [Workday session](docs/workday-session.md)
- [工作总结示例](docs/examples/workday-summary.zh-CN.md)
- [Codex App 本地插件安装](docs/codex-app-plugin-install.md)
- [Codex App 工作日指南](docs/codex-app-workday-guide.md)
- [Codex 工作日插件](docs/codex-workday-plugin.md)
- [Project presentation checklist](docs/project-presentation.md)
- [v0.2.0 release record](docs/release-v0.2.0.md)
- [Manual smoke evidence ledger](docs/manual-smoke-evidence-ledger.md)
- [MCP client setup](docs/mcp-client-setup.md)
- [Read-only MCP examples](docs/mcp-readonly-examples.md)
- [Agent context eval scaffold](benchmarks/evals/README.md)
- [Windows app compatibility](docs/windows-app-compatibility.md)
- [Windows developer app compatibility](docs/windows-developer-app-compatibility.md)
- [Watcher preview](docs/watcher-preview.md)
- [Maintenance and release history index](docs/maintenance-index.md)
- [Contributing](CONTRIBUTING.md)

历史 audit、sweep、readiness 和 release 记录继续保留在 maintenance index,
不再堆在 README 中。
22 changes: 21 additions & 1 deletion docs/maintenance-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,18 @@ This index keeps historical maintenance, audit, readiness, and release evidence
reachable without making the README a ledger. It is historical reference only;
it does not start a new maintenance loop or authorize new release work.

## Core Product Docs
## Current User Navigation

- [Windows first run](windows-first-run.md)
- [5-minute demo](quick-demo.md)
- [Codex App workday guide](codex-app-workday-guide.md)
- [MCP client setup](mcp-client-setup.md)
- [Privacy architecture](privacy-architecture.md)
- [Roadmap](roadmap.md)
- [Known limitations](known-limitations.md)
- [Contributing](../CONTRIBUTING.md)

## Productization And Product Docs

- [v0.2 monitor session](v0.2-monitor-session.md)
- [v0.2.0 release record](release-v0.2.0.md)
Expand All @@ -24,6 +35,15 @@ it does not start a new maintenance loop or authorize new release work.
- [Release evidence guide](release-evidence.md)
- [Contributing](../CONTRIBUTING.md)

## Productization Release Trail

- v0.2.24: automation guardrails.
- v0.2.25: README hero and social preview assets.
- v0.2.26: three-path onboarding.
- v0.2.27: synthetic workday summary examples.
- v0.2.28: Codex App, CLI, and MCP usage surface clarity.
- v0.2.29: docs navigation polish and finite productization completion.

## Post-v0.1.18 History

- [v0.1.19 maintenance release record](release-v0.1.19.md)
Expand Down
31 changes: 31 additions & 0 deletions docs/project-presentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,26 @@ not include third-party logos, real desktop screenshots, OCR/screen-recording
visuals, cloud-upload imagery, surveillance metaphors, desktop-control cues, or
official-brand implications.

## Positioning Against Codex Chronicle

Use this when a launch post or repository description needs the comparison
without putting a long table on the README first screen.

WinChronicle is independent from OpenAI. Official Codex Chronicle is a
Codex-native macOS research preview. WinChronicle is a Windows-first,
UIA-first, local-first, auditable, read-only MCP layer for agent context.

| Area | Official Codex Chronicle | WinChronicle |
| --- | --- | --- |
| Platform | Codex App research preview on macOS. | Windows-first open-source project. |
| Context source | Recent screen context. | Microsoft UI Automation metadata and explicit finite sessions. |
| Memory integration | Codex-native memories. | Local captures, SQLite search, deterministic reports, and read-only MCP. |
| Screenshots/OCR | Official docs describe selected screenshots and OCR as possible inputs. | Not implemented as the default baseline; remains off by default. |
| Local storage | Official docs describe temporary local captures and generated local memories. | Local state under `%LOCALAPPDATA%\WinChronicle` by default, or `WINCHRONICLE_HOME` for isolated demos/tests. |
| MCP interface | Not positioned as the primary Chronicle interface. | Fixed read-only MCP tool list for local context. |
| Desktop control | Not positioned as a desktop-control API. | No click/type/key/clipboard/screenshot/OCR/audio/cloud/MCP-write tools. |
| Privacy stance | Opt-in preview with sensitive-content warnings. | Redaction-first; observed content is untrusted; capture expansion needs human approval. |

## First-Time Visitor Path

Point new users to:
Expand All @@ -71,6 +91,17 @@ Point new users to:
4. [Privacy architecture](privacy-architecture.md)
5. [Contributing](../CONTRIBUTING.md)

## Productization Completion Note

For the final productization patch release, say:

```text
This release completes the finite v0.2 productization pass: guardrails, README
hero assets, three-path onboarding, synthetic workday examples, Codex usage
surface clarity, and compact docs navigation are now in place. It does not add
new capture surfaces or start a new maintenance loop.
```

## Good First Issue Themes

- Add deterministic UIA fixtures.
Expand Down
2 changes: 1 addition & 1 deletion plugins/winchronicle-workday/.codex-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "winchronicle-workday",
"version": "0.2.28",
"version": "0.2.29",
"description": "Thin Codex entry point for explicit WinChronicle workday recording.",
"author": {
"name": "YSCJRH",
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "winchronicle"
version = "0.2.28"
version = "0.2.29"
description = "UIA-first local memory for Windows agents."
readme = "README.md"
requires-python = ">=3.11"
Expand Down
2 changes: 1 addition & 1 deletion src/winchronicle/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.2.28"
__version__ = "0.2.29"
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "winchronicle-workday",
"version": "0.2.28",
"version": "0.2.29",
"description": "Thin Codex entry point for explicit WinChronicle workday recording.",
"author": {
"name": "YSCJRH",
Expand Down
2 changes: 1 addition & 1 deletion tests/test_version_identity.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ def test_project_runtime_and_mcp_versions_match(tmp_path):
pyproject = tomllib.loads((ROOT / "pyproject.toml").read_text(encoding="utf-8"))
project_version = pyproject["project"]["version"]

assert project_version == "0.2.28"
assert project_version == "0.2.29"
assert winchronicle.__version__ == project_version
assert _mcp_server_version(tmp_path / "state") == project_version

Expand Down