@cerefox/memory 1.0.0-beta.3 → 1.0.0-rc.1

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.
package/README.md CHANGED
@@ -10,6 +10,10 @@ curated knowledge layer that multiple AI tools can read and write.
10
10
  > npm package does **not** give you a working KB on its own; you also need a
11
11
  > Supabase project + an embedding API key, and a one-time server-side deploy
12
12
  > (`cerefox server deploy` — no repo clone needed). **See "Before you install" below.**
13
+ >
14
+ > Prefer no cloud at all? There is also **Cerefox Local**: the same stack in a
15
+ > single Docker container on your machine (this npm package is not needed for
16
+ > it). See [setup-local.md](https://github.com/fstamatelopoulos/cerefox/blob/main/docs/guides/setup-local.md).
13
17
 
14
18
  **Why cloud-backed?** Cerefox is designed as a *cloud-backed* memory layer so
15
19
  the same knowledge is reachable from every agent you run — Claude Code on
@@ -52,7 +56,7 @@ You deploy the server side with this package's CLI — `cerefox server deploy` s
52
56
  | Prerequisite | Why | How |
53
57
  |---|---|---|
54
58
  | A **Supabase project** | Hosts Postgres + pgvector + Edge Functions. Free tier is enough for most personal use. | [supabase.com](https://supabase.com) → New project |
55
- | An **embedding API key** | OpenAI `text-embedding-3-small` (default) or Fireworks AI. Pennies/month for typical personal use (see [operational-cost.md](https://github.com/fstamatelopoulos/cerefox/blob/main/docs/guides/operational-cost.md)). | Get an [OpenAI API key](https://platform.openai.com/api-keys). |
59
+ | An **embedding API key** | OpenAI `text-embedding-3-small` (the only embedder wired today). Pennies/month for typical personal use (see [operational-cost.md](https://github.com/fstamatelopoulos/cerefox/blob/main/docs/guides/operational-cost.md)). | Get an [OpenAI API key](https://platform.openai.com/api-keys). |
56
60
  | **Node ≥ 20** or **Bun ≥ 1.0** | Runtime for the `cerefox` bin (and the bundled `cerefox mcp` server). | [nodejs.org](https://nodejs.org) · [bun.sh](https://bun.sh). The one-line installer below bootstraps Bun if neither is present. |
57
61
 
58
62
  ### One-time server-side setup (~10 min — no clone needed)
@@ -112,12 +116,10 @@ already provisioned (see "Before you install").
112
116
  > `cerefox doctor` will flag it and point you back to
113
117
  > `cerefox server deploy`.
114
118
 
115
- > **Upgrading from the Python `cerefox` CLI?** If you have a working
116
- > `.env` in your repo clone, init detects it and offers to **copy** it to
117
- > `~/.cerefox/.env` so the TS CLI uses the new home while Python keeps
118
- > reading the repo file unchanged (`cerefox init` walks you through the choice).
119
- > Existing users with no `~/.cerefox/.env` see zero behavior change until they
120
- > opt in.
119
+ > **Have a `.env` from an earlier install (e.g. a repo clone)?** `cerefox init`
120
+ > detects it and offers to copy it to `~/.cerefox/.env` — the env-var names are
121
+ > identical, no rewrite needed. (The Python implementation was fully removed at
122
+ > v1.0.0; see the [migration guide](https://github.com/fstamatelopoulos/cerefox/blob/main/docs/guides/migration-1.0.md).)
121
123
 
122
124
  ---
123
125
 
@@ -132,8 +134,7 @@ cerefox configure-agent --tool codex # ~/.codex/config.toml
132
134
  cerefox configure-agent --tool gemini # ~/.gemini/settings.json
133
135
  ```
134
136
 
135
- All five writers landed in v0.6. For manual configuration, the canonical MCP
136
- entry is:
137
+ For manual configuration (any other MCP client), the canonical entry is:
137
138
 
138
139
  ```json
139
140
  {