teammem 0.1.0__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 (46) hide show
  1. teammem-0.1.0/LICENSE +201 -0
  2. teammem-0.1.0/PKG-INFO +241 -0
  3. teammem-0.1.0/README.md +214 -0
  4. teammem-0.1.0/pyproject.toml +44 -0
  5. teammem-0.1.0/setup.cfg +4 -0
  6. teammem-0.1.0/teammem/__init__.py +0 -0
  7. teammem-0.1.0/teammem/bundles.py +151 -0
  8. teammem-0.1.0/teammem/cli.py +297 -0
  9. teammem-0.1.0/teammem/config.py +45 -0
  10. teammem-0.1.0/teammem/docs_sync.py +49 -0
  11. teammem-0.1.0/teammem/events.py +21 -0
  12. teammem-0.1.0/teammem/feishu_collector.py +102 -0
  13. teammem-0.1.0/teammem/gitlab_collector.py +77 -0
  14. teammem-0.1.0/teammem/identity.py +65 -0
  15. teammem-0.1.0/teammem/importer.py +108 -0
  16. teammem-0.1.0/teammem/queries.py +85 -0
  17. teammem-0.1.0/teammem/reclaim.py +59 -0
  18. teammem-0.1.0/teammem/render.py +253 -0
  19. teammem-0.1.0/teammem/slices.py +52 -0
  20. teammem-0.1.0/teammem/store.py +85 -0
  21. teammem-0.1.0/teammem/summarize.py +121 -0
  22. teammem-0.1.0/teammem/vaultgit.py +30 -0
  23. teammem-0.1.0/teammem.egg-info/PKG-INFO +241 -0
  24. teammem-0.1.0/teammem.egg-info/SOURCES.txt +44 -0
  25. teammem-0.1.0/teammem.egg-info/dependency_links.txt +1 -0
  26. teammem-0.1.0/teammem.egg-info/entry_points.txt +2 -0
  27. teammem-0.1.0/teammem.egg-info/requires.txt +5 -0
  28. teammem-0.1.0/teammem.egg-info/top_level.txt +1 -0
  29. teammem-0.1.0/tests/test_bundles.py +120 -0
  30. teammem-0.1.0/tests/test_cli.py +346 -0
  31. teammem-0.1.0/tests/test_config.py +41 -0
  32. teammem-0.1.0/tests/test_docs_sync.py +31 -0
  33. teammem-0.1.0/tests/test_events.py +15 -0
  34. teammem-0.1.0/tests/test_feishu_collector.py +76 -0
  35. teammem-0.1.0/tests/test_gitlab_collector.py +97 -0
  36. teammem-0.1.0/tests/test_identity.py +83 -0
  37. teammem-0.1.0/tests/test_importer.py +127 -0
  38. teammem-0.1.0/tests/test_memberkit_integration.py +54 -0
  39. teammem-0.1.0/tests/test_public_scan.py +68 -0
  40. teammem-0.1.0/tests/test_queries.py +86 -0
  41. teammem-0.1.0/tests/test_reclaim.py +82 -0
  42. teammem-0.1.0/tests/test_render.py +242 -0
  43. teammem-0.1.0/tests/test_slices.py +72 -0
  44. teammem-0.1.0/tests/test_store.py +67 -0
  45. teammem-0.1.0/tests/test_summarize.py +158 -0
  46. teammem-0.1.0/tests/test_vaultgit.py +16 -0
teammem-0.1.0/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
teammem-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,241 @@
1
+ Metadata-Version: 2.4
2
+ Name: teammem
3
+ Version: 0.1.0
4
+ Summary: Local-first team activity ledger, member-bundle importer, and Markdown renderer
5
+ Author: Team Memory Agent contributors
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/xiongxhc/team-memory-agent
8
+ Project-URL: Documentation, https://github.com/xiongxhc/team-memory-agent#readme
9
+ Project-URL: Issues, https://github.com/xiongxhc/team-memory-agent/issues
10
+ Project-URL: Repository, https://github.com/xiongxhc/team-memory-agent
11
+ Keywords: agents,knowledge-management,local-first,team-memory
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Environment :: Console
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Topic :: Office/Business
19
+ Requires-Python: >=3.11
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Requires-Dist: PyYAML>=6.0
23
+ Requires-Dist: requests>=2.31
24
+ Provides-Extra: dev
25
+ Requires-Dist: pytest>=8.0; extra == "dev"
26
+ Dynamic: license-file
27
+
28
+ # Team Memory Agent
29
+
30
+ Team Memory Agent turns scattered team activity into a local, queryable event
31
+ ledger and regenerated Markdown reports. It combines central signals such as forge
32
+ commits and shared project-channel messages with member-reviewed local highlights.
33
+
34
+ The privacy boundary is simple: MemberKit prepares a JSON bundle locally, the
35
+ member reviews it, and nothing is transmitted until that member explicitly runs
36
+ `memberkit push`. Scheduled runs create drafts and reminders only.
37
+
38
+ ## Components
39
+
40
+ | Component | Installed by | Purpose |
41
+ |---|---|---|
42
+ | `teammem` | Hub operator | Collect, import, query, and render |
43
+ | `teammem-memberkit` | Individual member | Draft, review, and push selected highlights |
44
+ | `teammem-bundle/v1` | Both packages | Frozen JSON protocol |
45
+
46
+ MemberKit is a standalone command-line package, not a skill. Members install only
47
+ `teammem-memberkit`; they do not clone this repository or install the hub.
48
+
49
+ ## Member quick start
50
+
51
+ ### 1. Get the two team-specific values
52
+
53
+ Ask the hub operator for:
54
+
55
+ - your roster slug, such as `alex`;
56
+ - the Git URL of the team-memory inbox, plus permission to push to it.
57
+
58
+ MemberKit v0.1 reads local observations from
59
+ [`claude-mem`](https://github.com/thedotmack/claude-mem). Its default database is
60
+ `~/.claude-mem/claude-mem.db`. You also need Python 3.11 or newer, `pipx`, and Git.
61
+
62
+ ### 2. Install and configure
63
+
64
+ Installing the package does not create a schedule or transmit anything.
65
+
66
+ ```bash
67
+ pipx install teammem-memberkit
68
+ memberkit setup
69
+ ```
70
+
71
+ Setup asks for the roster slug and inbox Git URL. On macOS it then proposes a daily
72
+ 17:30 reminder in the member's local timezone: press Enter to accept, enter another
73
+ `HH:MM`, or enter `no` to decline. The configuration is stored with user-only
74
+ permissions at `~/.config/teammem/memberkit.env`.
75
+
76
+ For unattended setup:
77
+
78
+ ```bash
79
+ memberkit setup \
80
+ --member alex \
81
+ --inbox-url git@forge.example:team/team-memory-inbox.git \
82
+ --time 17:30
83
+ ```
84
+
85
+ Use `--no-schedule` instead of `--time` to configure MemberKit without installing
86
+ the macOS schedule.
87
+
88
+ ### 3. Review before sharing
89
+
90
+ The schedule prepares a local draft and shows a reminder. It never pushes. Review
91
+ today's draft:
92
+
93
+ ```bash
94
+ memberkit review
95
+ ```
96
+
97
+ To remove private items, edit the `events` list in
98
+ `~/.memberkit/out/bundle-<member>-<YYYY-MM-DD>.json`, save valid JSON, and review
99
+ again. `journal_md` is only a preview and is regenerated from the reviewed event
100
+ list when pushing.
101
+
102
+ Share the reviewed date, or dismiss it without sharing:
103
+
104
+ ```bash
105
+ memberkit push --date YYYY-MM-DD
106
+ memberkit dismiss --date YYYY-MM-DD
107
+ ```
108
+
109
+ The date defaults to today for `draft`, `review`, `push`, and `dismiss`. Removed or
110
+ dismissed events remain excluded from later catch-up drafts.
111
+
112
+ ### Schedule behavior
113
+
114
+ A scheduled run checks yesterday and today, preserving every event's original local
115
+ calendar date. With the default 17:30 schedule, work from 17:30–23:59 is discovered
116
+ the next day but remains in the earlier day's catch-up draft. Work at or after
117
+ midnight belongs to the next calendar day. Older unfinished dates remain in later
118
+ reminders.
119
+
120
+ ```bash
121
+ memberkit schedule status
122
+ memberkit schedule install --time 17:30
123
+ memberkit schedule remove
124
+ memberkit scheduled-run
125
+ ```
126
+
127
+ Automatic schedule installation currently supports macOS launchd. Other platforms
128
+ can schedule the portable `memberkit scheduled-run` command. If an edited draft is
129
+ invalid JSON, a scheduled run leaves it untouched and keeps reminding the member
130
+ to repair it. To discard a malformed draft, delete that local draft file before
131
+ running `memberkit dismiss --date YYYY-MM-DD`.
132
+
133
+ See the complete
134
+ [MemberKit guide](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/member-guide.md)
135
+ for upgrades, troubleshooting, files created locally, and safe removal.
136
+
137
+ ## Hub quick start
138
+
139
+ The hub operator manages the central collectors, roster, inbox importer, ledger,
140
+ and rendered views. Install the published command in an isolated environment:
141
+
142
+ ```bash
143
+ pipx install teammem
144
+ mkdir -p ~/.config/teammem
145
+ curl -fsSL \
146
+ https://raw.githubusercontent.com/xiongxhc/team-memory-agent/master/config/roster.example.yaml \
147
+ -o ~/.config/teammem/roster.yaml
148
+ curl -fsSL \
149
+ https://raw.githubusercontent.com/xiongxhc/team-memory-agent/master/config/projects.example.yaml \
150
+ -o ~/.config/teammem/projects.yaml
151
+ ```
152
+
153
+ Edit both configuration files before collecting or importing data. Operators who
154
+ are developing adapters or running from a pinned checkout can instead use:
155
+
156
+ ```bash
157
+ git clone https://github.com/xiongxhc/team-memory-agent.git
158
+ cd team-memory-agent
159
+ python3 -m venv .venv
160
+ .venv/bin/pip install -e .
161
+ cp config/roster.example.yaml config/roster.yaml
162
+ cp config/projects.example.yaml config/projects.yaml
163
+ ```
164
+
165
+ Import reviewed bundles into a local ledger:
166
+
167
+ ```bash
168
+ TEAMMEM_DB=ledger.db TEAMMEM_CONFIG_DIR=~/.config/teammem \
169
+ teammem import-bundles \
170
+ --inbox inbox \
171
+ --archive archive \
172
+ --quarantine quarantine
173
+ ```
174
+
175
+ Render Markdown views:
176
+
177
+ ```bash
178
+ TEAMMEM_DB=ledger.db TEAMMEM_CONFIG_DIR=~/.config/teammem TEAMMEM_VAULT=vault \
179
+ teammem render
180
+ ```
181
+
182
+ GitLab and Feishu collectors are optional. LLM-backed synthesis is optional; the
183
+ ledger, bundle importer, queries, and deterministic renderer work without it.
184
+
185
+ The operator should create a private inbox Git repository, grant each member push
186
+ access, and give each member an inbox URL and roster slug. Import from a disposable
187
+ export of the inbox, not directly from its Git working tree, because accepted
188
+ files are consumed from the import directory. See
189
+ [deployment](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/deployment.md)
190
+ for the complete operator and MemberKit lifecycle.
191
+
192
+ Upgrade or uninstall the packaged command with:
193
+
194
+ ```bash
195
+ pipx upgrade teammem
196
+ pipx uninstall teammem
197
+ ```
198
+
199
+ Uninstalling the command does not remove operator-owned configuration, ledgers,
200
+ archives, quarantine records, or rendered views.
201
+
202
+ ## Principles
203
+
204
+ - The SQLite ledger is truth; Markdown output is disposable and regenerated.
205
+ - Import is idempotent per attributed event.
206
+ - Unknown central identities are surfaced; unknown MemberKit identities are
207
+ quarantined.
208
+ - Shared-channel collection requires a visibly present integration.
209
+ - Raw local databases, direct messages, and arbitrary files never enter a bundle.
210
+ - This project provides work visibility, not employee scoring or performance
211
+ evaluation.
212
+
213
+ See
214
+ [architecture](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/architecture.md),
215
+ [privacy](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/privacy.md),
216
+ [deployment](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/deployment.md),
217
+ the
218
+ [MemberKit guide](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/member-guide.md),
219
+ and the
220
+ [`teammem-bundle/v1` contract](https://github.com/xiongxhc/team-memory-agent/blob/master/schemas/teammem-bundle-v1.md).
221
+
222
+ ## Development
223
+
224
+ ```bash
225
+ python3 -m venv .venv
226
+ .venv/bin/pip install -e '.[dev]'
227
+ .venv/bin/pip install -e packages/memberkit
228
+ .venv/bin/pytest -q tests packages/memberkit/tests
229
+ ./scripts/check-public.sh
230
+ ```
231
+
232
+ Before publication, the extracting operator should also provide a private regular
233
+ expression containing origin-specific organization and member identifiers without
234
+ committing it:
235
+
236
+ ```bash
237
+ TEAMMEM_PUBLIC_DENY_REGEX='<private-regex>' ./scripts/check-public.sh
238
+ ```
239
+
240
+ This project is licensed under Apache-2.0. The code owner authorized publication
241
+ under that license on 2026-07-27.
@@ -0,0 +1,214 @@
1
+ # Team Memory Agent
2
+
3
+ Team Memory Agent turns scattered team activity into a local, queryable event
4
+ ledger and regenerated Markdown reports. It combines central signals such as forge
5
+ commits and shared project-channel messages with member-reviewed local highlights.
6
+
7
+ The privacy boundary is simple: MemberKit prepares a JSON bundle locally, the
8
+ member reviews it, and nothing is transmitted until that member explicitly runs
9
+ `memberkit push`. Scheduled runs create drafts and reminders only.
10
+
11
+ ## Components
12
+
13
+ | Component | Installed by | Purpose |
14
+ |---|---|---|
15
+ | `teammem` | Hub operator | Collect, import, query, and render |
16
+ | `teammem-memberkit` | Individual member | Draft, review, and push selected highlights |
17
+ | `teammem-bundle/v1` | Both packages | Frozen JSON protocol |
18
+
19
+ MemberKit is a standalone command-line package, not a skill. Members install only
20
+ `teammem-memberkit`; they do not clone this repository or install the hub.
21
+
22
+ ## Member quick start
23
+
24
+ ### 1. Get the two team-specific values
25
+
26
+ Ask the hub operator for:
27
+
28
+ - your roster slug, such as `alex`;
29
+ - the Git URL of the team-memory inbox, plus permission to push to it.
30
+
31
+ MemberKit v0.1 reads local observations from
32
+ [`claude-mem`](https://github.com/thedotmack/claude-mem). Its default database is
33
+ `~/.claude-mem/claude-mem.db`. You also need Python 3.11 or newer, `pipx`, and Git.
34
+
35
+ ### 2. Install and configure
36
+
37
+ Installing the package does not create a schedule or transmit anything.
38
+
39
+ ```bash
40
+ pipx install teammem-memberkit
41
+ memberkit setup
42
+ ```
43
+
44
+ Setup asks for the roster slug and inbox Git URL. On macOS it then proposes a daily
45
+ 17:30 reminder in the member's local timezone: press Enter to accept, enter another
46
+ `HH:MM`, or enter `no` to decline. The configuration is stored with user-only
47
+ permissions at `~/.config/teammem/memberkit.env`.
48
+
49
+ For unattended setup:
50
+
51
+ ```bash
52
+ memberkit setup \
53
+ --member alex \
54
+ --inbox-url git@forge.example:team/team-memory-inbox.git \
55
+ --time 17:30
56
+ ```
57
+
58
+ Use `--no-schedule` instead of `--time` to configure MemberKit without installing
59
+ the macOS schedule.
60
+
61
+ ### 3. Review before sharing
62
+
63
+ The schedule prepares a local draft and shows a reminder. It never pushes. Review
64
+ today's draft:
65
+
66
+ ```bash
67
+ memberkit review
68
+ ```
69
+
70
+ To remove private items, edit the `events` list in
71
+ `~/.memberkit/out/bundle-<member>-<YYYY-MM-DD>.json`, save valid JSON, and review
72
+ again. `journal_md` is only a preview and is regenerated from the reviewed event
73
+ list when pushing.
74
+
75
+ Share the reviewed date, or dismiss it without sharing:
76
+
77
+ ```bash
78
+ memberkit push --date YYYY-MM-DD
79
+ memberkit dismiss --date YYYY-MM-DD
80
+ ```
81
+
82
+ The date defaults to today for `draft`, `review`, `push`, and `dismiss`. Removed or
83
+ dismissed events remain excluded from later catch-up drafts.
84
+
85
+ ### Schedule behavior
86
+
87
+ A scheduled run checks yesterday and today, preserving every event's original local
88
+ calendar date. With the default 17:30 schedule, work from 17:30–23:59 is discovered
89
+ the next day but remains in the earlier day's catch-up draft. Work at or after
90
+ midnight belongs to the next calendar day. Older unfinished dates remain in later
91
+ reminders.
92
+
93
+ ```bash
94
+ memberkit schedule status
95
+ memberkit schedule install --time 17:30
96
+ memberkit schedule remove
97
+ memberkit scheduled-run
98
+ ```
99
+
100
+ Automatic schedule installation currently supports macOS launchd. Other platforms
101
+ can schedule the portable `memberkit scheduled-run` command. If an edited draft is
102
+ invalid JSON, a scheduled run leaves it untouched and keeps reminding the member
103
+ to repair it. To discard a malformed draft, delete that local draft file before
104
+ running `memberkit dismiss --date YYYY-MM-DD`.
105
+
106
+ See the complete
107
+ [MemberKit guide](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/member-guide.md)
108
+ for upgrades, troubleshooting, files created locally, and safe removal.
109
+
110
+ ## Hub quick start
111
+
112
+ The hub operator manages the central collectors, roster, inbox importer, ledger,
113
+ and rendered views. Install the published command in an isolated environment:
114
+
115
+ ```bash
116
+ pipx install teammem
117
+ mkdir -p ~/.config/teammem
118
+ curl -fsSL \
119
+ https://raw.githubusercontent.com/xiongxhc/team-memory-agent/master/config/roster.example.yaml \
120
+ -o ~/.config/teammem/roster.yaml
121
+ curl -fsSL \
122
+ https://raw.githubusercontent.com/xiongxhc/team-memory-agent/master/config/projects.example.yaml \
123
+ -o ~/.config/teammem/projects.yaml
124
+ ```
125
+
126
+ Edit both configuration files before collecting or importing data. Operators who
127
+ are developing adapters or running from a pinned checkout can instead use:
128
+
129
+ ```bash
130
+ git clone https://github.com/xiongxhc/team-memory-agent.git
131
+ cd team-memory-agent
132
+ python3 -m venv .venv
133
+ .venv/bin/pip install -e .
134
+ cp config/roster.example.yaml config/roster.yaml
135
+ cp config/projects.example.yaml config/projects.yaml
136
+ ```
137
+
138
+ Import reviewed bundles into a local ledger:
139
+
140
+ ```bash
141
+ TEAMMEM_DB=ledger.db TEAMMEM_CONFIG_DIR=~/.config/teammem \
142
+ teammem import-bundles \
143
+ --inbox inbox \
144
+ --archive archive \
145
+ --quarantine quarantine
146
+ ```
147
+
148
+ Render Markdown views:
149
+
150
+ ```bash
151
+ TEAMMEM_DB=ledger.db TEAMMEM_CONFIG_DIR=~/.config/teammem TEAMMEM_VAULT=vault \
152
+ teammem render
153
+ ```
154
+
155
+ GitLab and Feishu collectors are optional. LLM-backed synthesis is optional; the
156
+ ledger, bundle importer, queries, and deterministic renderer work without it.
157
+
158
+ The operator should create a private inbox Git repository, grant each member push
159
+ access, and give each member an inbox URL and roster slug. Import from a disposable
160
+ export of the inbox, not directly from its Git working tree, because accepted
161
+ files are consumed from the import directory. See
162
+ [deployment](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/deployment.md)
163
+ for the complete operator and MemberKit lifecycle.
164
+
165
+ Upgrade or uninstall the packaged command with:
166
+
167
+ ```bash
168
+ pipx upgrade teammem
169
+ pipx uninstall teammem
170
+ ```
171
+
172
+ Uninstalling the command does not remove operator-owned configuration, ledgers,
173
+ archives, quarantine records, or rendered views.
174
+
175
+ ## Principles
176
+
177
+ - The SQLite ledger is truth; Markdown output is disposable and regenerated.
178
+ - Import is idempotent per attributed event.
179
+ - Unknown central identities are surfaced; unknown MemberKit identities are
180
+ quarantined.
181
+ - Shared-channel collection requires a visibly present integration.
182
+ - Raw local databases, direct messages, and arbitrary files never enter a bundle.
183
+ - This project provides work visibility, not employee scoring or performance
184
+ evaluation.
185
+
186
+ See
187
+ [architecture](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/architecture.md),
188
+ [privacy](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/privacy.md),
189
+ [deployment](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/deployment.md),
190
+ the
191
+ [MemberKit guide](https://github.com/xiongxhc/team-memory-agent/blob/master/docs/member-guide.md),
192
+ and the
193
+ [`teammem-bundle/v1` contract](https://github.com/xiongxhc/team-memory-agent/blob/master/schemas/teammem-bundle-v1.md).
194
+
195
+ ## Development
196
+
197
+ ```bash
198
+ python3 -m venv .venv
199
+ .venv/bin/pip install -e '.[dev]'
200
+ .venv/bin/pip install -e packages/memberkit
201
+ .venv/bin/pytest -q tests packages/memberkit/tests
202
+ ./scripts/check-public.sh
203
+ ```
204
+
205
+ Before publication, the extracting operator should also provide a private regular
206
+ expression containing origin-specific organization and member identifiers without
207
+ committing it:
208
+
209
+ ```bash
210
+ TEAMMEM_PUBLIC_DENY_REGEX='<private-regex>' ./scripts/check-public.sh
211
+ ```
212
+
213
+ This project is licensed under Apache-2.0. The code owner authorized publication
214
+ under that license on 2026-07-27.