@aaryanbindage/omnicontext 0.0.0-stage → 0.1.3
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/LICENSE +21 -0
- package/README.md +159 -2
- package/dist/omnicontext.mjs +149 -0
- package/package.json +58 -4
- package/src/cli.js +200 -0
- package/src/context.js +85 -0
- package/src/index.js +5 -0
- package/src/install.js +67 -0
- package/src/mcp.js +323 -0
- package/src/resolve.js +55 -0
- package/src/store.js +303 -0
- package/src/sync.js +127 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 aaryanbindage
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,160 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center"><img src="docs/icon.png" width="96" alt="OmniContext logo" /></p>
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<h1 align="center">OmniContext</h1>
|
|
4
|
+
|
|
5
|
+
<p align="center"><b>Persistent, cross-device memory for Claude.</b><br/>
|
|
6
|
+
Every Claude session — Claude Code, Claude Desktop, any MCP client, on any of your machines — knows who you are, what you're working on, and where you left off.</p>
|
|
7
|
+
|
|
8
|
+
<p align="center">
|
|
9
|
+
<a href="https://github.com/aaryanbindage/omnicontext/releases/latest">Download (Mac · Windows · Linux)</a> ·
|
|
10
|
+
<a href="#claude-code-plugin">Claude Code plugin</a> ·
|
|
11
|
+
<a href="#claude-desktop--other-mcp-clients">MCP server</a> ·
|
|
12
|
+
<a href="https://aaryanbindage.github.io/omnicontext/">Website</a>
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
<p align="center">
|
|
16
|
+
<a href="https://www.npmjs.com/package/@aaryanbindage/omnicontext"><img alt="npm" src="https://img.shields.io/npm/v/@aaryanbindage/omnicontext"></a>
|
|
17
|
+
<a href="https://github.com/aaryanbindage/omnicontext/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/aaryanbindage/omnicontext/actions/workflows/ci.yml/badge.svg"></a>
|
|
18
|
+
<a href="LICENSE"><img alt="MIT" src="https://img.shields.io/badge/license-MIT-blue"></a>
|
|
19
|
+
</p>
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
You (on your laptop): continue my game project
|
|
25
|
+
Claude: Resuming Starfall (the Godot space roguelike). Last session on your desktop
|
|
26
|
+
you finished the enemy state machine; next up is the boss fight timings…
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## What it does
|
|
30
|
+
|
|
31
|
+
- **Knows you.** A profile (role, preferences, tools, facts) shared with every session. Claude adds to it when you tell it something lasting (`remember`).
|
|
32
|
+
- **Knows your projects.** Name them once, give them nicknames, and "my game project", "the website" or "that bot" resolve to the right one in any session. Each project keeps notes, its repo, and its folder on each device.
|
|
33
|
+
- **Resumes across devices.** `/omnicontext:handoff` saves a self-contained summary and next steps. On another machine, `/omnicontext:resume` picks it up and opens the project's folder on that device.
|
|
34
|
+
- **Syncs without a cloud service.** Your memory is a folder of plain Markdown and JSON files (`~/.omnicontext`) synced through a **private git repo you own**. Nothing goes to a third-party server.
|
|
35
|
+
- **Works everywhere.** It's a Claude Code plugin with auto-injected context, an MCP server for Claude Desktop, Cursor, VS Code, Windsurf and Zed, a desktop app for Mac, Windows and Linux, and a CLI.
|
|
36
|
+
|
|
37
|
+
## Install
|
|
38
|
+
|
|
39
|
+
### Desktop app (Mac · Windows · Linux)
|
|
40
|
+
|
|
41
|
+
Download from **[Releases](https://github.com/aaryanbindage/omnicontext/releases/latest)**:
|
|
42
|
+
|
|
43
|
+
| OS | File |
|
|
44
|
+
|---|---|
|
|
45
|
+
| Windows | `OmniContext-Setup-x.y.z.exe` (installer) or `…-Windows-x64.zip` (portable) |
|
|
46
|
+
| macOS | `…-macOS-arm64.dmg` (Apple Silicon) / `…-macOS-x64.dmg` (Intel) |
|
|
47
|
+
| Linux | `…-Linux-x86_64.AppImage` / `…-Linux-amd64.deb` (x64), `…-Linux-arm64.AppImage` / `…-Linux-arm64.deb` (ARM64, e.g. Raspberry Pi 4/5) |
|
|
48
|
+
|
|
49
|
+
The app lets you edit your profile, projects and handoffs, set up sync, and connect Claude Code and Claude Desktop with one click. It stays in the tray and syncs in the background.
|
|
50
|
+
|
|
51
|
+
> macOS builds aren't notarized yet. If macOS says the app is damaged, run `xattr -cr /Applications/OmniContext.app`.
|
|
52
|
+
|
|
53
|
+
### Claude Code plugin
|
|
54
|
+
|
|
55
|
+
```text
|
|
56
|
+
/plugin marketplace add aaryanbindage/omnicontext
|
|
57
|
+
/plugin install omnicontext@omnicontext
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Requires Node.js 18+. You get:
|
|
61
|
+
|
|
62
|
+
| | |
|
|
63
|
+
|---|---|
|
|
64
|
+
| **SessionStart hook** | injects your profile, project index, the current project, and open handoffs |
|
|
65
|
+
| **SessionEnd hook** | syncs your memory to your other devices |
|
|
66
|
+
| `/omnicontext:handoff [title]` | save the current work so it can be resumed anywhere |
|
|
67
|
+
| `/omnicontext:resume [project]` | continue the latest (or a named) handoff |
|
|
68
|
+
| `/omnicontext:remember <fact>` | remember something about you or a project |
|
|
69
|
+
| `/omnicontext:project [name aka nickname]` | register this folder as a project |
|
|
70
|
+
| `/omnicontext:sync` | sync now |
|
|
71
|
+
| MCP tools + skill | Claude resolves "my X project", saves notes and handoffs |
|
|
72
|
+
|
|
73
|
+
### Claude Desktop & other MCP clients
|
|
74
|
+
|
|
75
|
+
**One click:** download `omnicontext.mcpb` from Releases and open it with Claude Desktop.
|
|
76
|
+
You can also use the desktop app (**Connect Claude → Install**) or run `npx @aaryanbindage/omnicontext install claude-desktop`.
|
|
77
|
+
|
|
78
|
+
**Manually** (Claude Desktop, Cursor, Windsurf, VS Code, Zed, Cline and others):
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"mcpServers": {
|
|
83
|
+
"omnicontext": { "command": "npx", "args": ["-y", "@aaryanbindage/omnicontext", "mcp"] }
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### CLI
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
npm i -g @aaryanbindage/omnicontext
|
|
92
|
+
omnicontext project add "Starfall" --alias "my game" --tag godot --desc "2D space roguelike" --path .
|
|
93
|
+
omnicontext resolve "my game project"
|
|
94
|
+
omnicontext remember "Prefers TypeScript and short answers"
|
|
95
|
+
omnicontext sync --github # one-time: create a private repo and sync
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Sync your devices
|
|
99
|
+
|
|
100
|
+
On your **first** device:
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
omnicontext sync --github # needs the GitHub CLI (gh auth login); creates <you>/omnicontext-data (private)
|
|
104
|
+
# or
|
|
105
|
+
omnicontext sync --remote <any git url you own>
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
On **every other** device, connect the same repo:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
omnicontext sync --remote https://github.com/<you>/omnicontext-data.git
|
|
112
|
+
omnicontext device "MacBook" # optional: a friendly device name
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
You can do the same from the desktop app's **Sync & devices** tab. After that, sync runs on its own: at the start and end of each Claude Code session, a few seconds after the MCP server makes a change, and every few minutes while the desktop app is open. Each record is its own file, so two devices rarely conflict. When they do, the local version wins, and git history keeps everything.
|
|
116
|
+
|
|
117
|
+
## MCP tools
|
|
118
|
+
|
|
119
|
+
| Tool | Purpose |
|
|
120
|
+
|---|---|
|
|
121
|
+
| `get_context` | Full briefing: profile, projects, open handoffs (for clients without hooks) |
|
|
122
|
+
| `get_profile` / `update_profile` / `remember` | Read and update what Claude knows about you |
|
|
123
|
+
| `list_projects` / `get_project` / `upsert_project` / `add_project_note` | Manage projects, nicknames, per-device folders, notes |
|
|
124
|
+
| `resolve_project` | "my game project" → the matching project, ranked |
|
|
125
|
+
| `save_handoff` / `list_handoffs` / `resume_handoff` / `complete_handoff` | Cross-device resume |
|
|
126
|
+
| `search_memory` | Search the profile, notes, and handoffs |
|
|
127
|
+
| `sync_now` | Push and pull with your other devices |
|
|
128
|
+
|
|
129
|
+
It also provides the prompts `resume` and `handoff`.
|
|
130
|
+
|
|
131
|
+
## Data format
|
|
132
|
+
|
|
133
|
+
```text
|
|
134
|
+
~/.omnicontext/
|
|
135
|
+
profile.md # you — edit freely
|
|
136
|
+
projects/starfall.json # name, aliases, tags, description, repo, paths per device, notes
|
|
137
|
+
handoffs/<id>.json # title, summary, next steps, files, device, status
|
|
138
|
+
local.json # this device only (name, sync prefs) — not synced
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Set `OMNICONTEXT_HOME` to use a different folder. You can also put the folder in Dropbox, iCloud or OneDrive instead of using git sync.
|
|
142
|
+
|
|
143
|
+
## Privacy
|
|
144
|
+
|
|
145
|
+
Everything stays on your machines and in the git remote you choose. OmniContext has no server, no telemetry, and no account. Don't store secrets in it. The instructions it gives Claude say the same.
|
|
146
|
+
|
|
147
|
+
## Development
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
npm install
|
|
151
|
+
npm test
|
|
152
|
+
npm run build # bundles dist/omnicontext.mjs (used by the plugin, the app, and npm)
|
|
153
|
+
cd app && npm install && npm start # run the desktop app
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
Releases: push a `v*` tag. GitHub Actions builds the Windows, macOS and Linux apps and the `.mcpb` bundle, and publishes to npm.
|
|
157
|
+
|
|
158
|
+
## License
|
|
159
|
+
|
|
160
|
+
MIT © aaryanbindage
|