Skip to content

Commit f3e6c7f

Browse files
committed
Add centered README banner and refresh badges
1 parent 2a3880a commit f3e6c7f

2 files changed

Lines changed: 42 additions & 16 deletions

File tree

README.md

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,40 @@
1-
# Solomon's Mise en Place
1+
<p align="center">
2+
<img src="docs/assets/solo-mise-banner.png" alt="Solomon's Mise en Place banner">
3+
</p>
24

3-
> Mise en place for agent memory.
5+
<h1 align="center">Solomon's Mise en Place</h1>
46

5-
`solo-mise` is the installable starter kit behind [Solomon's Guide to Cookin' with Gas](https://github.com/solomonneas/solos-cookbook). It lays down a public-safe agent workspace, a memory handoff flow, and a bootstrap layout that works with OpenClaw, Claude Code, Codex, Hermes, and other coding harnesses.
7+
<p align="center">
8+
<strong>Mise en place for agent memory.</strong>
9+
</p>
610

7-
The cookbook explains the *why*. This package gives you the *kitchen*.
11+
<p align="center">
12+
<em>Public-safe workspace bootstrap, memory handoffs, and publish guards for real agent setups.</em>
13+
</p>
14+
15+
<p align="center">
16+
<img src="https://img.shields.io/github/actions/workflow/status/solomonneas/solo-mise/ci.yml?branch=main&style=for-the-badge&label=ci" alt="CI status">
17+
<img src="https://img.shields.io/badge/python-3.10%2B-blue?style=for-the-badge&logo=python&logoColor=white" alt="Python 3.10+">
18+
<img src="https://img.shields.io/badge/license-MIT-green?style=for-the-badge" alt="MIT license">
19+
<img src="https://img.shields.io/badge/profiles-6-orange?style=for-the-badge" alt="6 profiles">
20+
</p>
21+
22+
<p align="center">
23+
<code>solo-mise</code> is the installable starter kit behind <a href="https://github.com/solomonneas/solos-cookbook">Solomon's Guide to Cookin' with Gas</a>.
24+
It gives you the workspace skeleton, handoff inbox, conservative ingester, and publish guard that make a multi-agent setup usable without leaking private junk into public repos.
25+
</p>
26+
27+
## What this is
28+
29+
This package lays down a clean starting point for an agent workspace or a repo that needs durable memory handoffs. It is meant for people running real tools, real docs, and real automation across OpenClaw, Claude Code, Codex, Hermes, or a similar harness.
30+
31+
The cookbook explains the why. This package gives you the kitchen.
832

933
## What you get
1034

1135
- sanitized bootstrap files for agent behavior, safety, tools, identity, and memory
1236
- a canonical memory layout where one configured owner holds durable knowledge
13-
- a `.claude/memory-handoffs/` inbox shared by Claude Code, Codex, and other side harnesses
37+
- a shared `.claude/memory-handoffs/` inbox for Claude Code, Codex, and other side harnesses
1438
- starter memory cards and routing rules
1539
- content-guard publish gates so private infrastructure does not leak into public docs
1640
- adapter fragments for OpenClaw (tested), Hermes (stubbed), and generic harnesses
@@ -21,7 +45,7 @@ The cookbook explains the *why*. This package gives you the *kitchen*.
2145
- private hostnames, IPs, account IDs, or personal details
2246
- live auth profiles or OAuth tokens
2347
- cron jobs that post publicly by default
24-
- destructive automation, or write-enabled integrations without explicit opt-in
48+
- destructive automation or write-enabled integrations without explicit opt-in
2549

2650
## Install
2751

@@ -33,12 +57,12 @@ pipx install git+https://github.com/solomonneas/solo-mise
3357

3458
```bash
3559
solo-mise init --target . # repo-local handoff flow + publish guard
36-
solo-mise init --target ~/my-workspace --profile workspace # full agent kitchen
37-
solo-mise doctor --target ~/my-workspace
60+
solo-mise init --target ~/agent-kitchen --profile workspace
61+
solo-mise doctor --target ~/agent-kitchen
3862
solo-mise scrub --target .
3963
```
4064

41-
See [QUICKSTART.md](QUICKSTART.md) for step-by-step setup and verification.
65+
See [QUICKSTART.md](QUICKSTART.md) for setup, verification, and the ingest flow.
4266

4367
## Profiles
4468

@@ -47,13 +71,13 @@ See [QUICKSTART.md](QUICKSTART.md) for step-by-step setup and verification.
4771
| `repo` *(default)* | `AGENTS.md`, `CLAUDE.md`, `.claude/memory-handoffs/`, pre-push hook | A project wants the handoff flow and a public-leak guard. |
4872
| `workspace` | Full bootstrap file set, memory folders, starter cards, safety files | A user wants a home agent workspace. |
4973
| `openclaw` | `workspace` plus OpenClaw config fragments and doctor checks | An OpenClaw user. |
50-
| `hermes` | `workspace` plus Hermes adapter fragments and doctor checks | A Hermes user. (Experimental.) |
51-
| `generic` | Contract docs and templates, no orchestrator config | A user who wants the layout without picking a harness yet. |
74+
| `hermes` | `workspace` plus Hermes adapter fragments and doctor checks | A Hermes user. Experimental. |
75+
| `generic` | Contract docs and templates, no orchestrator config | A user wants the layout without picking a harness yet. |
5276
| `publisher` | content-guard policies, scrub commands, publish gates | A user who publishes blog posts, docs, or social drafts. |
5377

5478
## The design
5579

56-
**Harness-agnostic contract, OpenClaw-tested defaults.** One memory owner is the source of truth. Side harnesses keep local context but write durable findings as Memory Handoffs into a shared inbox. A conservative ingester routes those into cards, runbooks, user prefs, rules, or learnings.
80+
One memory owner stays canonical. Side harnesses keep local context, but durable findings move through a shared handoff inbox and into the right destination.
5781

5882
```text
5983
Claude Code / Codex / other harness
@@ -68,12 +92,14 @@ solo-mise ingest (or your harness's equivalent)
6892
memory/cards/*.md, TOOLS.md, USER.md, rules/*.md, .learnings/*.md
6993
```
7094

95+
The ingester is intentionally conservative. Safe card handoffs become cards. Targeted updates append to the right file. Ambiguous material gets kicked out for review instead of being trusted automatically.
96+
7197
## Related
7298

73-
- [Solomon's Cookbook](https://github.com/solomonneas/solos-cookbook) - the long-form guide and reference docs
74-
- [content-guard](https://github.com/solomonneas/content-guard) - the publish-gate scanner used by the pre-push hook
75-
- [OpenClaw](https://github.com/openclaw/openclaw) - the reference memory owner
99+
- [Solomon's Cookbook](https://github.com/solomonneas/solos-cookbook): the long-form guide and reference docs
100+
- [content-guard](https://github.com/solomonneas/content-guard): the publish-gate scanner used by the pre-push hook
101+
- [OpenClaw](https://github.com/openclaw/openclaw): the reference memory owner
76102

77103
## License
78104

79-
MIT.
105+
MIT

docs/assets/solo-mise-banner.png

2.95 MB
Loading

0 commit comments

Comments
 (0)