S-01 · 5-minute guide

書いた plan / bugfix が
次の行動に変わる。

docsweep は、AI や人が作る作業 Markdown を状態・期限・安全な archive で整える道具です。 「何からやる?」「これは寝かせる?」「もう片づけていい?」を、同じルールで扱えます。

Python 3.10+ / Windows・macOS・Linux / CLI + Web UI + MCP / MIT License

docsweep が作業メモを次の行動へ変える流れ plan、bugfix、pending を docsweep が読み取り、今日の一件、様子見、archive へ導く図 作業のメモ plan_*.md bugfix_*.md pending_*.md 散らばっても、 同じ形式で読める docsweep 状態を読む 期限を見せる 安全に運ぶ 今日の 1 個 brief / triage 様子見 再発確認を守る archive 削除せず隔離する
作業メモを「書いたまま」にせず、いま必要な判断と次の置き場へつなぎます。
大事な約束: 期限が来ただけで archive しません。完了・廃止・昇格は、人または明示的な操作が決めます。 docsweep はタスク管理アプリへの置き換えではなく、すでに書かれた Markdown を正本のまま扱います。

S-02 · Install

入れて、設定を作って、開く。

配布は PyPI です。別バイナリは作らず、Python の module として起動します。

  1. インストールする

    コアだけなら 1 行目。Web UI・対話レビュー・MCP まで使うなら 2 行目を選びます。

    pip install docsweep
    pip install 'docsweep[all]'

    extras は web / review / mcp / watch / resurrect / all があります。

  2. 既定の設定を作る

    初回だけ init を実行します。設定は全 OS 共通で ~/.docsweep/ に置かれます。

    python -m docsweep init

    PATH を汚さない。docsweep ... は Scripts/bin が PATH にある人向けの短縮形です。

  3. 今日の 1 件を出す

    何も思い出せない状態でも、brief が「まずこれ」を 1 件に断定します。

    python -m docsweep brief             # cwd のプロジェクト
    python -m docsweep brief --all       # 全プロジェクト横並び
    python -m docsweep cross             # 横断の俯瞰
  4. 看板を開く(任意)

    画面で見渡したいときは Web UI を起動します。バインドは 127.0.0.1 固定です。

    python -m docsweep serve --root ~/dev
AI に使わせるなら: MCP クライアントには python -m docsweep mcp を登録します。 再現性を上げるなら command に Python 実行ファイルの絶対パスを指定してください。 各プロジェクトへ運用ルールを配るときは python -m docsweep inject、 新しい作業メモは python -m docsweep new plan <topic> で作ります。

S-03 · State model

ファイル名ではなく、いまの状態で扱う。

H1 ラベルと frontmatter の docsweep_state を同期し、状態ごとに「次にできる操作」を決めます。 これが、AI と人が同じ運用を共有する土台です。

docsweep の状態モデル 保留、計画、実行中、様子見、完了、廃止の状態遷移を表す図 plan の代表的な一本道。bugfix は「実行中」から始まり、pending は「保留」を起点にします。 保留まだ始めない 計画やることを置く 実行中いま進める 様子見再発確認を守る 完了archive 対象 廃止 → archive どの可動状態からでも、不要なら廃止へ

「完了」と「様子見」は別の状態です。様子見は守る。完了・廃止だけを archive 対象にします。

保留

今は着手しない。条件がそろったら計画へ。

計画

やることを残す。古くなれば要判断として見える。

実行中

現在の仕事。期限があれば「今日」と「やり忘れ」に出る。

様子見

直ったが再発確認中。sweep は勝手に触らない。

完了

判断済み。archive へ移せる。

廃止

不要と判断。削除せず archive へ隔離する。

S-04 · Daily loop

朝に 1 件、終わったら 1 回。

判断の粒度を小さくします。毎回この流れを完璧にやる必要はありません。迷いが出た時だけ、同じ入口に戻れます。

  1. 今日の入口を開く

    brief / triage で、残作業から今やる 1 件を選びます。

    何から始めるかで止まらない。
  2. 状態を変える

    計画・実行中・様子見を、H1 と frontmatter で揃えます。AI も同じ操作を使います。

    「実装済みなのに計画」のズレを減らす。
  3. 様子を見る

    修正後は様子見へ。卒業期限を付け、必要なら今回だけ日数も変えられます。

    早すぎる完了にも、放置にも寄らない。
  4. 明示して片づける

    期限到来分を下見し、昇格・archive を実行します。削除はしません。

    現役フォルダが、いまの仕事だけになる。
brief / triage 作業状態を同期 確認様子見を守る 整理archive へ移送

S-05 · Watching

直した直後に完了にしない。
でも、寝かせっぱなしにもならない。

「もう閉じてよいか」という曖昧な記憶を、見直す日付へ変えます。 それでも最終的に archive へ送る判断は、明示操作のままです。

修正した様子見へ遷移 今日 + N 日due が卒業期限 明示昇格done → archive Day 0期限到来判断後 再発したら実行中へ戻す

期限は「自動削除の時刻」ではなく、再確認する合図です。到来分だけを下見してから昇格します。

既定は 3 日。プロジェクトごとに変えられる。

due.default_offset_days.plan_watchingbugfix_watching で、様子見の標準日数を持てます。

今回だけ 5 日、もできる。

設定ファイルを変えず、その状態遷移にだけ適用されます。MCP なら watching_days=5 です。

python -m docsweep apply --path <md> \
  --action relabel --to watching --watching-days 5

期限が来たものだけ、下見してから昇格。

due 到来(当日を含む)かつ様子見の文書だけが対象です。期限が無いもの・未来のものは動きません。

python -m docsweep promote --due-expired --dry-run
python -m docsweep promote --due-expired
この節は v0.5.0 以降の機能です。 卒業期限と promote --due-expired / --watching-days は v0.5.0 で追加しました。 それ以前の版では、様子見からの昇格は手動のラベル変更で行います。

S-06 · Interfaces

人の画面、CLI、AI の MCP が
同じ状態モデルを共有する。

入口が違っても、結果のルールがずれません。Web UI は新しい特権を持たず、CLI / MCP と同じ内部関数を呼びます。

人が見る

Web UI

看板で、期限・やり忘れ・様子見を見渡す。カードで状態や期日を操作する。

自動化する

CLI

dry-run、JSON、CI、定期処理。確認できる出力を先に取り、明示して実行する。

AI が使う

MCP

自然言語の入口から brief、triage、apply、promote を呼び、AI の行動を記録可能にする。

S-07 · Boundaries

便利にするほど、勝手に決めない。

削除しない

archive は隔離

物理削除の口を持たず、完了・廃止は archive へ。過去の判断を失いません。

期限だけでは動かない

due は合図

期限到来は「確認する時期」。自動で完了や archive にはしません。

状態変更は明示

人・AI が意思を入れる

CLI、MCP、Web UI の明示操作で初めて状態が変わります。dry-run で先に対象も確認できます。

S-08 · FAQ

よくある質問

既存の plan / bugfix を書き換えられてしまいませんか?

状態を変える操作をしない限り、本文には触れません。archive も移動であって削除ではなく、 物理削除の口を実装として持っていません。CLI は --dry-run で先に対象を確認できます。

期限が切れたら勝手に片づきますか?

片づきません。due は「もう一度見る合図」です。完了・廃止・昇格は、人または明示的な操作でだけ起きます。 様子見の文書は sweep の自動移送対象からも外れています。

作業メモの置き場所は決まっていますか?

既定はプロジェクト相対の docs/local/ ですが、設定で変えられます。 Git ignore された非公開の queue を使う運用も想定していて、その場合は書き込み前に ignore されているかを確認します。

複数のリポジトリをまたいで使えますか?

使えます。cross と SQLite 索引で、リポジトリをまたいだ優先順位を見渡せます。 プロジェクト単位で有効・無効も切り替えられます。

AI エージェントに操作させても大丈夫ですか?

MCP と CLI は人と同じ状態モデル・同じ境界の上で動きます。 --auto / --json は非対話を厳守するので、プロンプトで止まりません。 一括で大量に動かすときは 2 段階の確認が入ります。