Metadata-Version: 2.4
Name: paper-harness-cli
Version: 0.6.0
Summary: CLI kernel for bootstrapping and maintaining paper-harness projects
Project-URL: Homepage, https://github.com/Nkzono99/paperops
Project-URL: Repository, https://github.com/Nkzono99/paperops
Project-URL: Issues, https://github.com/Nkzono99/paperops/issues
Author: paperops maintainers
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# paperops

`paperops` は、AI エージェントと論文を書くためのプロジェクトハーネスである。

人間が `template/` を手でコピーして使う道具ではなく、`pops` CLI で論文プロジェクトを初期化・診断・更新する。

## まず使う

新規論文プロジェクト:

```sh
uvx --from paper-harness-cli pops init paper-my-topic
cd paper-my-topic
uvx --from paper-harness-cli pops doctor
```

既存プロジェクトを `pops` 管理に寄せる:

```sh
uvx --from paper-harness-cli pops setup
uvx --from paper-harness-cli pops doctor
```

`pops` は常に `uvx --from paper-harness-cli pops ...` で実行する。`.venv` は CLI 用ではなく、論文プロジェクト側の Python 実行環境が必要な場合に `make venv` で作る。

## 何を提供するか

- `template/`: 個別論文リポジトリに展開される scaffold
- `src/paperops/`: scaffold を初期化・診断・更新する `pops` CLI
- `.github/workflows/`: 下流論文リポジトリから呼び出せる reusable workflow
- `.agents/skills/`, `.claude/skills/`: paperops 自体を保守するための skill
- `docs/`: CLI、配布、アーキテクチャ、変更ルール

## 論文プロジェクトの基本モデル

下流の論文リポジトリでは、原稿だけでなく中間層も明示的に持つ。

- `evidence/`: result / figure / source card の正本
- `claims/`: claim / scientific gate / argument card の正本
- `review/`: 人間レビュー、査読コメント、返答のカード
- `requests/`: 追加解析や改稿依頼のカード
- `notes/views/`: カード正本を人間が俯瞰するビュー
- `manuscript/ja`, `manuscript/en`: block ID で対応する原稿
- `refs/`: 文献サマリー、外部 source、外部 project link
- `refs/imports/`: 外部 export bundle の source index / integrity / provenance state
- `_handoff/`: 人間から AI へ渡す未整理ファイルの一時置き場

人間は主に原稿レベルのレビューや自然文の指示を出す。Agent はそれを `review/feedback/` の card にし、必要なら claim / gate / evidence / request / manuscript へ遡って反映する。

## よく使うコマンド

```sh
uvx --from paper-harness-cli pops version
uvx --from paper-harness-cli pops doctor
uvx --from paper-harness-cli pops update-paperops --plan
uvx --from paper-harness-cli pops update-paperops --apply
uvx --from paper-harness-cli pops links check
```

下流プロジェクトでの確認:

```sh
make ci
make pre-submit
make figure-reference-check
```

paperops 本体の確認:

```sh
make venv
make smoke
```

## 詳細

- CLI: [docs/cli.md](docs/cli.md)
- 配布とリリース: [docs/distribution.md](docs/distribution.md)
- アーキテクチャ: [docs/architecture.md](docs/architecture.md)
- Skill 一覧: [docs/skill-catalog.md](docs/skill-catalog.md)
- 更新方針: [docs/upgrade-policy.md](docs/upgrade-policy.md)
- 変更ルール: [docs/change-policy.md](docs/change-policy.md), [docs/triage-rules.md](docs/triage-rules.md)
