miseenplace-cli 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. miseenplace_cli-0.1.1/.gitignore +23 -0
  2. miseenplace_cli-0.1.1/CHANGELOG.md +18 -0
  3. miseenplace_cli-0.1.1/LICENSE +202 -0
  4. miseenplace_cli-0.1.1/PKG-INFO +140 -0
  5. miseenplace_cli-0.1.1/README.md +110 -0
  6. miseenplace_cli-0.1.1/docs/agent-cost.md +19 -0
  7. miseenplace_cli-0.1.1/docs/assets/social-preview.png +0 -0
  8. miseenplace_cli-0.1.1/docs/assets/social-preview.svg +18 -0
  9. miseenplace_cli-0.1.1/docs/cli.md +55 -0
  10. miseenplace_cli-0.1.1/docs/concepts.md +54 -0
  11. miseenplace_cli-0.1.1/docs/data-model.md +49 -0
  12. miseenplace_cli-0.1.1/docs/index.md +17 -0
  13. miseenplace_cli-0.1.1/docs/launch.md +32 -0
  14. miseenplace_cli-0.1.1/docs/quickstart.md +85 -0
  15. miseenplace_cli-0.1.1/docs/security.md +42 -0
  16. miseenplace_cli-0.1.1/docs/sources.md +40 -0
  17. miseenplace_cli-0.1.1/docs/writing-a-source.md +39 -0
  18. miseenplace_cli-0.1.1/docs/writing-a-storage-backend.md +40 -0
  19. miseenplace_cli-0.1.1/examples/demo-data/inbox.json +18 -0
  20. miseenplace_cli-0.1.1/llms.txt +20 -0
  21. miseenplace_cli-0.1.1/pyproject.toml +95 -0
  22. miseenplace_cli-0.1.1/scripts/check_no_personal.py +59 -0
  23. miseenplace_cli-0.1.1/scripts/publish_github.sh +39 -0
  24. miseenplace_cli-0.1.1/scripts/record_demo.sh +29 -0
  25. miseenplace_cli-0.1.1/skills/inbox-triage/SKILL.md +39 -0
  26. miseenplace_cli-0.1.1/skills/inbox-triage/references/decisions.md +13 -0
  27. miseenplace_cli-0.1.1/skills/inbox-watch/SKILL.md +28 -0
  28. miseenplace_cli-0.1.1/skills/inbox-watch/references/claude-code.md +15 -0
  29. miseenplace_cli-0.1.1/skills/inbox-watch/references/cron.md +11 -0
  30. miseenplace_cli-0.1.1/skills/inbox-watch/references/launchd.md +28 -0
  31. miseenplace_cli-0.1.1/skills/inbox-watch/references/systemd.md +33 -0
  32. miseenplace_cli-0.1.1/skills/journal/SKILL.md +41 -0
  33. miseenplace_cli-0.1.1/skills/learn-style/SKILL.md +28 -0
  34. miseenplace_cli-0.1.1/skills/setup/SKILL.md +36 -0
  35. miseenplace_cli-0.1.1/src/miseenplace/__init__.py +3 -0
  36. miseenplace_cli-0.1.1/src/miseenplace/__main__.py +5 -0
  37. miseenplace_cli-0.1.1/src/miseenplace/assets.py +19 -0
  38. miseenplace_cli-0.1.1/src/miseenplace/chat.py +26 -0
  39. miseenplace_cli-0.1.1/src/miseenplace/cli.py +551 -0
  40. miseenplace_cli-0.1.1/src/miseenplace/config.py +91 -0
  41. miseenplace_cli-0.1.1/src/miseenplace/consent.py +230 -0
  42. miseenplace_cli-0.1.1/src/miseenplace/inbox.py +216 -0
  43. miseenplace_cli-0.1.1/src/miseenplace/lock.py +63 -0
  44. miseenplace_cli-0.1.1/src/miseenplace/model.py +313 -0
  45. miseenplace_cli-0.1.1/src/miseenplace/personal.py +99 -0
  46. miseenplace_cli-0.1.1/src/miseenplace/private.py +52 -0
  47. miseenplace_cli-0.1.1/src/miseenplace/py.typed +0 -0
  48. miseenplace_cli-0.1.1/src/miseenplace/render.py +200 -0
  49. miseenplace_cli-0.1.1/src/miseenplace/sources/__init__.py +33 -0
  50. miseenplace_cli-0.1.1/src/miseenplace/sources/_template.py +73 -0
  51. miseenplace_cli-0.1.1/src/miseenplace/sources/base.py +140 -0
  52. miseenplace_cli-0.1.1/src/miseenplace/sources/demo.py +168 -0
  53. miseenplace_cli-0.1.1/src/miseenplace/sources/zulip.py +456 -0
  54. miseenplace_cli-0.1.1/src/miseenplace/storage/__init__.py +48 -0
  55. miseenplace_cli-0.1.1/src/miseenplace/storage/_template.py +52 -0
  56. miseenplace_cli-0.1.1/src/miseenplace/storage/base.py +74 -0
  57. miseenplace_cli-0.1.1/src/miseenplace/storage/git.py +190 -0
  58. miseenplace_cli-0.1.1/src/miseenplace/storage/local.py +115 -0
  59. miseenplace_cli-0.1.1/src/miseenplace/storage/logmerge.py +36 -0
  60. miseenplace_cli-0.1.1/src/miseenplace/store.py +281 -0
  61. miseenplace_cli-0.1.1/src/miseenplace/tour.py +101 -0
  62. miseenplace_cli-0.1.1/src/miseenplace/watch.py +64 -0
  63. miseenplace_cli-0.1.1/tests/__init__.py +0 -0
  64. miseenplace_cli-0.1.1/tests/conftest.py +71 -0
  65. miseenplace_cli-0.1.1/tests/contract/__init__.py +0 -0
  66. miseenplace_cli-0.1.1/tests/contract/test_source_contract.py +144 -0
  67. miseenplace_cli-0.1.1/tests/contract/test_storage_contract.py +142 -0
  68. miseenplace_cli-0.1.1/tests/http_server.py +75 -0
  69. miseenplace_cli-0.1.1/tests/memory_storage.py +56 -0
  70. miseenplace_cli-0.1.1/tests/test_cli.py +194 -0
  71. miseenplace_cli-0.1.1/tests/test_consent.py +106 -0
  72. miseenplace_cli-0.1.1/tests/test_consent_hardening.py +216 -0
  73. miseenplace_cli-0.1.1/tests/test_hygiene.py +109 -0
  74. miseenplace_cli-0.1.1/tests/test_inbox.py +119 -0
  75. miseenplace_cli-0.1.1/tests/test_inbox_hardening.py +152 -0
  76. miseenplace_cli-0.1.1/tests/test_model.py +80 -0
  77. miseenplace_cli-0.1.1/tests/test_output_budget.py +32 -0
  78. miseenplace_cli-0.1.1/tests/test_personal.py +66 -0
  79. miseenplace_cli-0.1.1/tests/test_render.py +105 -0
  80. miseenplace_cli-0.1.1/tests/test_sources.py +160 -0
  81. miseenplace_cli-0.1.1/tests/test_storage.py +95 -0
  82. miseenplace_cli-0.1.1/tests/test_storage_hardening.py +334 -0
  83. miseenplace_cli-0.1.1/tests/test_storage_helpers.py +9 -0
  84. miseenplace_cli-0.1.1/tests/test_store.py +274 -0
  85. miseenplace_cli-0.1.1/tests/test_zulip_hardening.py +75 -0
@@ -0,0 +1,23 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ *.tmp
4
+ .venv/
5
+ dist/
6
+ build/
7
+ site/
8
+ .mypy_cache/
9
+ .ruff_cache/
10
+ .pytest_cache/
11
+ .cache/
12
+ *.egg-info/
13
+ # personal data never belongs here
14
+ data/
15
+ Action Items.md
16
+ /config.toml
17
+ /style/
18
+ /corpus/
19
+ /requests.jsonl
20
+ /demo/
21
+ state/
22
+ .env
23
+ .zuliprc
@@ -0,0 +1,18 @@
1
+ # Changelog
2
+
3
+ ## 0.1.1
4
+
5
+ - Published on PyPI as `miseenplace-cli` (the name `miseenplace` is too close to an existing project). Commands stay `miseenplace` and `mep`.
6
+
7
+ ## 0.1.0
8
+
9
+ First release.
10
+
11
+ - Journal: add, set, done, drop, log, list, top, brief, standup, sync; append-only audit log with replay validation; rendered page.
12
+ - Inbox: `inbox`, `triage`, `watch` with per-consumer cursors and one compact line per actionable item.
13
+ - Sources: Protocol contract; Zulip and a file-backed demo source.
14
+ - Consent gate: `draft` stores exact text, `send` takes only a draft id and delivers once.
15
+ - Pluggable storage: `local`, `git` and custom backends via `module:Class` or the `miseenplace.storage` entry point.
16
+ - Your words as data: `note-request` log, `style` file and sent-message corpus.
17
+ - Agent Skills: setup, journal, inbox-triage, inbox-watch, learn-style; Claude Code plugin manifest.
18
+ - `mep demo` guided tour; docs site; stdlib-only runtime, Python 3.11 to 3.14.
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,140 @@
1
+ Metadata-Version: 2.5
2
+ Name: miseenplace-cli
3
+ Version: 0.1.1
4
+ Summary: Every ask, in its place. A chef's mise en place for your workday: the asks, promises and nudges from chat, laid out before the day starts. Agent-native.
5
+ Project-URL: Homepage, https://ankitkpandey1.github.io/miseenplace/
6
+ Project-URL: Documentation, https://ankitkpandey1.github.io/miseenplace/
7
+ Project-URL: Repository, https://github.com/ankitkpandey1/miseenplace
8
+ Project-URL: Issues, https://github.com/ankitkpandey1/miseenplace/issues
9
+ Project-URL: Changelog, https://github.com/ankitkpandey1/miseenplace/blob/main/CHANGELOG.md
10
+ Author: miseenplace contributors
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ Keywords: action-items,agent-skills,ai-agents,audit-log,claude-code,cli,codex,cursor,gemini-cli,inbox-zero,journal,productivity,standup,task-manager,todo,work-log,zulip
14
+ Classifier: Development Status :: 4 - Beta
15
+ Classifier: Environment :: Console
16
+ Classifier: Intended Audience :: Developers
17
+ Classifier: License :: OSI Approved :: Apache Software License
18
+ Classifier: Operating System :: OS Independent
19
+ Classifier: Programming Language :: Python :: 3
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Programming Language :: Python :: 3.14
24
+ Classifier: Topic :: Communications :: Chat
25
+ Classifier: Topic :: Office/Business :: Scheduling
26
+ Classifier: Topic :: Utilities
27
+ Classifier: Typing :: Typed
28
+ Requires-Python: >=3.11
29
+ Description-Content-Type: text/markdown
30
+
31
+ # miseenplace
32
+
33
+ **Every ask, in its place.** An agent-native CLI and set of skills that lay out the asks, promises and nudges from your chat before the day starts: a chef's mise en place for your workday, for Claude Code, Codex, Gemini CLI and Cursor.
34
+
35
+ [![PyPI](https://img.shields.io/pypi/v/miseenplace-cli)](https://pypi.org/project/miseenplace-cli/)
36
+ [![CI](https://github.com/ankitkpandey1/miseenplace/actions/workflows/ci.yml/badge.svg)](https://github.com/ankitkpandey1/miseenplace/actions/workflows/ci.yml)
37
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
38
+ [![Python](https://img.shields.io/pypi/pyversions/miseenplace-cli)](https://pypi.org/project/miseenplace-cli/)
39
+
40
+ ## Paste this into your agent
41
+
42
+ ```text
43
+ Install miseenplace with `uv tool install miseenplace-cli`, run `miseenplace skills` to find the
44
+ bundled agent skills, copy them into your skills directory, then run the setup skill and
45
+ follow it. Ask me only for things you cannot find out yourself.
46
+ ```
47
+
48
+ No account? `uvx --from miseenplace-cli mep demo` runs a two-minute tour on fictional data.
49
+
50
+ ### Where the skills go
51
+
52
+ | Tool | Skills directory (user level) | Project level |
53
+ |---|---|---|
54
+ | Claude Code | `~/.claude/skills/` | `.claude/skills/` |
55
+ | Codex | `~/.agents/skills/` | `.agents/skills/` |
56
+ | Gemini CLI | `~/.gemini/skills/` (alias `~/.agents/skills/`) | `.gemini/skills/` |
57
+ | Cursor | `~/.cursor/skills/` (also reads `~/.agents/skills/`) | `.cursor/skills/` |
58
+
59
+ Paths are from each tool's documentation at the time of writing; if your version differs, check your tool's docs.
60
+ Copy the bundled skills with the directory for your tool (Claude Code shown):
61
+
62
+ ```bash
63
+ mkdir -p ~/.claude/skills && cp -r "$(mep skills)"/* ~/.claude/skills/
64
+ ```
65
+
66
+ Claude Code can also install it as a plugin, with no copying:
67
+
68
+ ```text
69
+ /plugin marketplace add ankitkpandey1/miseenplace
70
+ /plugin install miseenplace@miseenplace
71
+ ```
72
+
73
+ ## Why
74
+
75
+ Chat is where work is asked for and promised, and it scrolls away. To-do apps start empty and trust you to copy things in. miseenplace reads your chat, keeps only what needs you, and turns it into an audit-logged action list your agent can drive.
76
+
77
+ - **One line per ask.** `mep inbox` shows `id · who · where · ask · action`, nothing else. Your own earlier answers hide the asks you already handled.
78
+ - **One call per decision.** `mep triage 12 --todo` files the item with link, topic and context filled in.
79
+ - **Agents cannot post free text.** `draft` stores the exact words; `send` takes only a draft id, after you said yes to that text.
80
+ - **Cheap to run.** The CLI does the deterministic work, so a small model can drive it. A tested output budget keeps a ten-message loop near 500 tokens.
81
+ - **Your data, your storage.** Local files, a private git repository, or a backend you write in 30 minutes.
82
+ - **Stdlib only.** No runtime dependencies. Python 3.11 to 3.14.
83
+
84
+ | | Plain to-do app | miseenplace |
85
+ |---|---|---|
86
+ | Captures asks from chat | you copy them in | reads the chat |
87
+ | Remembers you already answered | no | hides answered asks |
88
+ | History | edits overwrite | append-only audit log, replay-validated |
89
+ | Agent can drive it | via a UI or an API | terse CLI plus short skills |
90
+ | Agent can post for you | n/a | only a stored draft you approved |
91
+ | Where data lives | the vendor | files you own, optionally in git |
92
+
93
+ ## Daily use
94
+
95
+ ```bash
96
+ mep inbox # only what needs you
97
+ mep triage 12 --todo --eta fri # journal it
98
+ mep triage 13 --reply-draft "Thursday" # stores the text, posts nothing
99
+ mep send d1a2b3c4e # after your yes on that exact text
100
+ mep top # what first
101
+ mep standup --since yesterday # Did / Next / Waiting on
102
+ mep watch # block until something needs you
103
+ ```
104
+
105
+ ## Skills
106
+
107
+ `skills/` follows the Agent Skills standard and also installs as a Claude Code plugin (`.claude-plugin/`).
108
+
109
+ | Skill | Does |
110
+ |---|---|
111
+ | `setup` | install, connect a source, verify |
112
+ | `journal` | keep items and the work diary |
113
+ | `inbox-triage` | inbox into journal items and drafted replies |
114
+ | `inbox-watch` | background watcher; wakes the agent on new asks |
115
+ | `learn-style` | learns how you write so drafts sound like you |
116
+
117
+ ## Storage
118
+
119
+ ```toml
120
+ # config.toml in the data root
121
+ [storage]
122
+ backend = "git" # local (default) | git | "package.module:ClassName"
123
+ remote = "git@host:me/my-data.git"
124
+ ```
125
+
126
+ The git backend pulls before reads and commits and pushes after writes; a failed push is an error. See [writing a storage backend](docs/writing-a-storage-backend.md).
127
+
128
+ ## Sources
129
+
130
+ Zulip and a demo source ship today. A new one takes about 30 minutes: [writing a source](docs/writing-a-source.md).
131
+
132
+ ## Your data is personal
133
+
134
+ The journal, your sent-message archive, your style file and a verbatim log of your requests live in your data root, never in this repository. Read [security](docs/security.md), especially what the consent gate does not guarantee.
135
+
136
+ ## Docs
137
+
138
+ [Quickstart](docs/quickstart.md) · [Concepts](docs/concepts.md) · [CLI](docs/cli.md) · [Data model](docs/data-model.md) · [Sources](docs/sources.md) · [Agent cost](docs/agent-cost.md) · [Security](docs/security.md) · [Contributing](CONTRIBUTING.md)
139
+
140
+ Apache-2.0.
@@ -0,0 +1,110 @@
1
+ # miseenplace
2
+
3
+ **Every ask, in its place.** An agent-native CLI and set of skills that lay out the asks, promises and nudges from your chat before the day starts: a chef's mise en place for your workday, for Claude Code, Codex, Gemini CLI and Cursor.
4
+
5
+ [![PyPI](https://img.shields.io/pypi/v/miseenplace-cli)](https://pypi.org/project/miseenplace-cli/)
6
+ [![CI](https://github.com/ankitkpandey1/miseenplace/actions/workflows/ci.yml/badge.svg)](https://github.com/ankitkpandey1/miseenplace/actions/workflows/ci.yml)
7
+ [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
8
+ [![Python](https://img.shields.io/pypi/pyversions/miseenplace-cli)](https://pypi.org/project/miseenplace-cli/)
9
+
10
+ ## Paste this into your agent
11
+
12
+ ```text
13
+ Install miseenplace with `uv tool install miseenplace-cli`, run `miseenplace skills` to find the
14
+ bundled agent skills, copy them into your skills directory, then run the setup skill and
15
+ follow it. Ask me only for things you cannot find out yourself.
16
+ ```
17
+
18
+ No account? `uvx --from miseenplace-cli mep demo` runs a two-minute tour on fictional data.
19
+
20
+ ### Where the skills go
21
+
22
+ | Tool | Skills directory (user level) | Project level |
23
+ |---|---|---|
24
+ | Claude Code | `~/.claude/skills/` | `.claude/skills/` |
25
+ | Codex | `~/.agents/skills/` | `.agents/skills/` |
26
+ | Gemini CLI | `~/.gemini/skills/` (alias `~/.agents/skills/`) | `.gemini/skills/` |
27
+ | Cursor | `~/.cursor/skills/` (also reads `~/.agents/skills/`) | `.cursor/skills/` |
28
+
29
+ Paths are from each tool's documentation at the time of writing; if your version differs, check your tool's docs.
30
+ Copy the bundled skills with the directory for your tool (Claude Code shown):
31
+
32
+ ```bash
33
+ mkdir -p ~/.claude/skills && cp -r "$(mep skills)"/* ~/.claude/skills/
34
+ ```
35
+
36
+ Claude Code can also install it as a plugin, with no copying:
37
+
38
+ ```text
39
+ /plugin marketplace add ankitkpandey1/miseenplace
40
+ /plugin install miseenplace@miseenplace
41
+ ```
42
+
43
+ ## Why
44
+
45
+ Chat is where work is asked for and promised, and it scrolls away. To-do apps start empty and trust you to copy things in. miseenplace reads your chat, keeps only what needs you, and turns it into an audit-logged action list your agent can drive.
46
+
47
+ - **One line per ask.** `mep inbox` shows `id · who · where · ask · action`, nothing else. Your own earlier answers hide the asks you already handled.
48
+ - **One call per decision.** `mep triage 12 --todo` files the item with link, topic and context filled in.
49
+ - **Agents cannot post free text.** `draft` stores the exact words; `send` takes only a draft id, after you said yes to that text.
50
+ - **Cheap to run.** The CLI does the deterministic work, so a small model can drive it. A tested output budget keeps a ten-message loop near 500 tokens.
51
+ - **Your data, your storage.** Local files, a private git repository, or a backend you write in 30 minutes.
52
+ - **Stdlib only.** No runtime dependencies. Python 3.11 to 3.14.
53
+
54
+ | | Plain to-do app | miseenplace |
55
+ |---|---|---|
56
+ | Captures asks from chat | you copy them in | reads the chat |
57
+ | Remembers you already answered | no | hides answered asks |
58
+ | History | edits overwrite | append-only audit log, replay-validated |
59
+ | Agent can drive it | via a UI or an API | terse CLI plus short skills |
60
+ | Agent can post for you | n/a | only a stored draft you approved |
61
+ | Where data lives | the vendor | files you own, optionally in git |
62
+
63
+ ## Daily use
64
+
65
+ ```bash
66
+ mep inbox # only what needs you
67
+ mep triage 12 --todo --eta fri # journal it
68
+ mep triage 13 --reply-draft "Thursday" # stores the text, posts nothing
69
+ mep send d1a2b3c4e # after your yes on that exact text
70
+ mep top # what first
71
+ mep standup --since yesterday # Did / Next / Waiting on
72
+ mep watch # block until something needs you
73
+ ```
74
+
75
+ ## Skills
76
+
77
+ `skills/` follows the Agent Skills standard and also installs as a Claude Code plugin (`.claude-plugin/`).
78
+
79
+ | Skill | Does |
80
+ |---|---|
81
+ | `setup` | install, connect a source, verify |
82
+ | `journal` | keep items and the work diary |
83
+ | `inbox-triage` | inbox into journal items and drafted replies |
84
+ | `inbox-watch` | background watcher; wakes the agent on new asks |
85
+ | `learn-style` | learns how you write so drafts sound like you |
86
+
87
+ ## Storage
88
+
89
+ ```toml
90
+ # config.toml in the data root
91
+ [storage]
92
+ backend = "git" # local (default) | git | "package.module:ClassName"
93
+ remote = "git@host:me/my-data.git"
94
+ ```
95
+
96
+ The git backend pulls before reads and commits and pushes after writes; a failed push is an error. See [writing a storage backend](docs/writing-a-storage-backend.md).
97
+
98
+ ## Sources
99
+
100
+ Zulip and a demo source ship today. A new one takes about 30 minutes: [writing a source](docs/writing-a-source.md).
101
+
102
+ ## Your data is personal
103
+
104
+ The journal, your sent-message archive, your style file and a verbatim log of your requests live in your data root, never in this repository. Read [security](docs/security.md), especially what the consent gate does not guarantee.
105
+
106
+ ## Docs
107
+
108
+ [Quickstart](docs/quickstart.md) · [Concepts](docs/concepts.md) · [CLI](docs/cli.md) · [Data model](docs/data-model.md) · [Sources](docs/sources.md) · [Agent cost](docs/agent-cost.md) · [Security](docs/security.md) · [Contributing](CONTRIBUTING.md)
109
+
110
+ Apache-2.0.
@@ -0,0 +1,19 @@
1
+ ---
2
+ description: How miseenplace keeps agent token cost low - deterministic work in the CLI, one compact line per item, short skills and a tested output budget.
3
+ ---
4
+
5
+ # Agent cost
6
+
7
+ A small model should be able to drive miseenplace. The design:
8
+
9
+ 1. **All deterministic work lives in the CLI.** Classification, bookkeeping, deduplication and formatting are code, not prompts.
10
+ 2. **The agent never reads raw digests.** `mep inbox` returns only actionable items, one line each: `id · who · where · ask (120 chars) · action`.
11
+ 3. **One call per decision.** `mep triage ID --todo` creates the journal item with reference, topic and context filled in.
12
+ 4. **Terse by default.** `--verbose` is for humans. The watcher prints at most one line per new item.
13
+ 5. **Short skills.** Each `SKILL.md` is at most 60 lines: imperative steps, exact commands, a fixed decision table. Detail is in `references/`, read on demand.
14
+
15
+ ## Measured
16
+
17
+ `tests/test_output_budget.py` fails if `mep inbox` for the demo data exceeds 700 characters, or if the whole triage loop (inbox plus three triage calls) exceeds 2000 characters, about 500 tokens. Compare: the demo chat in raw form is several times larger.
18
+
19
+ If you change an output format, the test tells you what it cost.
@@ -0,0 +1,18 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" width="1280" height="640" viewBox="0 0 1280 640" role="img" aria-label="miseenplace: every ask, in its place">
2
+ <rect width="1280" height="640" fill="#14181f"/>
3
+ <g fill="#232a35" stroke="#2f3846" stroke-width="2">
4
+ <rect x="80" y="400" width="340" height="150" rx="14"/>
5
+ <rect x="470" y="400" width="340" height="150" rx="14"/>
6
+ <rect x="860" y="400" width="340" height="150" rx="14"/>
7
+ </g>
8
+ <g font-family="ui-monospace, Menlo, Consolas, monospace" font-size="24" fill="#c9d4e3">
9
+ <text x="108" y="450">reply</text><text x="108" y="490" fill="#7e8da3">Changelog ETA?</text>
10
+ <text x="498" y="450">todo</text><text x="498" y="490" fill="#7e8da3">Review parser PR</text>
11
+ <text x="888" y="450">waiting</text><text x="888" y="490" fill="#7e8da3">Sam: retro notes</text>
12
+ </g>
13
+ <g font-family="system-ui, -apple-system, Segoe UI, sans-serif">
14
+ <text x="80" y="200" font-size="104" font-weight="700" fill="#f2f5fa">miseenplace</text>
15
+ <text x="84" y="270" font-size="44" fill="#e9b44c">Every ask, in its place.</text>
16
+ <text x="84" y="330" font-size="28" fill="#9fb0c7">An agent-native CLI and skills that lay out your chat's asks before the day starts.</text>
17
+ </g>
18
+ </svg>
@@ -0,0 +1,55 @@
1
+ ---
2
+ description: Reference for every miseenplace command (mep) - journal, inbox, triage, watch, drafts, style and request log.
3
+ ---
4
+
5
+ # CLI reference
6
+
7
+ `miseenplace` and `mep` are the same program. Global options go before the command: `--dir PATH`, `--source NAME`, `--version`. Environment: `MISEENPLACE_DIR`, `MISEENPLACE_SOURCE`.
8
+
9
+ Exit codes: 0 ok, 1 usage or journal error, 2 source error (network, auth). Errors are one line on stderr.
10
+
11
+ ## Journal
12
+
13
+ | Command | Purpose |
14
+ |---|---|
15
+ | `add TITLE [--kind mine\|waiting\|reminder] [--who] [--eta] [--ref] [--topic] [--context] [--next] [--priority]` | new item |
16
+ | `set ID [--state] [--note] [--spent] [--tag] [--decision]` | change an item |
17
+ | `done ID [--note]` / `drop ID` | close |
18
+ | `log TEXT [--topic] [--spent]` | diary entry |
19
+ | `list [--topic] [--tag] [--sort]` | list items |
20
+ | `top [-n N]` | what first |
21
+ | `brief ID_OR_TOPIC` | full view |
22
+ | `standup [--since yesterday]` | Did / Next / Waiting on |
23
+ | `sync` | pull, render the page, publish (storage decides) |
24
+
25
+ ## Inbox
26
+
27
+ | Command | Purpose |
28
+ |---|---|
29
+ | `inbox [--cursor NAME] [--json] [--all] [--verbose]` | only actionable items, `id · who · where · ask · action` |
30
+ | `triage ID --todo\|--waiting\|--ignore\|--reply-draft TEXT [--eta] [--topic]` | one call per item; exactly one action |
31
+ | `watch [--cursor NAME] [--interval 300] [--once]` | block until a new actionable item, print, exit 0; `--interval` is at least 10; `--once` exits 0 with empty output when nothing is new; errors go to `state/watch.log` |
32
+
33
+ ## Source
34
+
35
+ | Command | Purpose |
36
+ |---|---|
37
+ | `new [--cursor NAME] [--init]` | raw new messages, silent if none |
38
+ | `thread --channel C --topic T` or `--dm NAME` | read a thread |
39
+ | `digest [--days N]` | grouped history for humans |
40
+ | `draft TEXT [--channel --topic \| --dm] [--reply-to ID]` | store the exact text; posts nothing |
41
+ | `drafts` | unsent drafts |
42
+ | `send DRAFT_ID [--mark-sent\|--mark-unsent]` | post a stored draft, only an id; the flags record what you found after an unconfirmed send |
43
+ | `users QUERY` | find people |
44
+
45
+ ## Your words
46
+
47
+ | Command | Purpose |
48
+ |---|---|
49
+ | `note-request TEXT` | append your exact words to `requests.jsonl` |
50
+ | `requests [-n N]` | read them back |
51
+ | `style show` / `style learn [--days N]` / `style sample` / `style set -` | style file and sent-message corpus |
52
+
53
+ ## Setup
54
+
55
+ `init` creates the data root and `config.toml`; `demo` runs the guided tour; `skills` prints the path of the bundled skills.
@@ -0,0 +1,54 @@
1
+ ---
2
+ description: The ideas behind miseenplace - the journal write-ahead log, sources, the inbox queue, cursors, the consent gate and pluggable storage.
3
+ ---
4
+
5
+ # Concepts
6
+
7
+ miseenplace is a chef's mise en place for the workday: everything asked of you, promised by you or owed to you, laid out before the day starts. Agents drive the CLI; the CLI does the deterministic work.
8
+
9
+ ## The journal
10
+
11
+ Items are things to do (`mine`), things you wait on (`waiting`) and reminders. Every change is one line appended to an audit log, which is the source of truth. A snapshot (`items.json`) is a cache rebuilt from the log, and `Action Items.md` is a page rendered from it. A write that fails validation writes nothing. See [Data model](data-model.md).
12
+
13
+ ## Sources
14
+
15
+ A source is a chat service behind a small contract: `new`, `thread`, `draft`, `send`, `users`. Zulip and a file-backed demo ship today. Writing another takes about 30 minutes: [Writing a source](writing-a-source.md).
16
+
17
+ `new` never returns your own messages. So an agent must re-read the thread before calling anything pending: you may already have answered.
18
+
19
+ ## Cursors
20
+
21
+ Each consumer (a watcher, an agent session, a cron job) has its own read position, one tiny file per cursor. Consumers never overwrite each other. A new cursor sets a baseline and reports nothing from before it.
22
+
23
+ ## The inbox queue
24
+
25
+ `mep inbox` ingests new messages into a queue (one file per message), classifies each (`reply`, `todo`, `waiting`, `ignore`) and prints only the actionable ones, one line each. Ingest queues first and classifies after, so a network failure loses nothing. Messages you already answered are hidden. `mep triage` handles one item in one call.
26
+
27
+ ## The consent gate
28
+
29
+ `draft` stores the exact text and returns a draft id. `send` accepts only a draft id and posts exactly the stored text, once. There is no way to send free text. This is structural, not proof that a human approved: see [Security](security.md) for what it does and does not guarantee.
30
+
31
+ ## Your words are data
32
+
33
+ Your own sent messages (`corpus/`), the style file learned from them (`style/`) and a verbatim log of what you asked your agent to do (`requests.jsonl`) live in the data root. Summaries drift; verbatim words do not.
34
+
35
+ ## Storage
36
+
37
+ The log, snapshot and named files go through a `Storage` backend chosen in `config.toml`:
38
+
39
+ ```toml
40
+ [storage]
41
+ backend = "local" # local (default) | git | "package.module:ClassName"
42
+ ```
43
+
44
+ - `local`: plain files under the data root.
45
+ - `git`: local files in a git repository; pulls before a read, commits and pushes after a write; a failed pull or push is an error, never silent.
46
+ - Your own: [Writing a storage backend](writing-a-storage-backend.md). Backends are also discoverable through the `miseenplace.storage` entry-point group.
47
+
48
+ ## Agent-native
49
+
50
+ Every command is terse by default and has a machine-readable form. Skills are short, with fixed decision tables, so a small model can drive them. See [Agent cost](agent-cost.md).
51
+
52
+ ## Concurrency and sync
53
+
54
+ Every write takes an exclusive lock on the data root (`.lock`, POSIX `fcntl`; Windows is untested), pulls first when the storage has a remote, then appends. The snapshot (`data/items.json`) stores a fingerprint of the log entry it was built from and is rebuilt whenever it disagrees with the log. With the git backend, two machines that both wrote are merged by keeping the remote's entries first and re-appending the local unpushed entries after them, renumbered; if git cannot merge, the merge is aborted and the repository is left clean.