bikky 0.4.1 → 0.4.2
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/CHANGELOG.md +6 -0
- package/CODE_OF_CONDUCT.md +1 -1
- package/CONTRIBUTING.md +1 -1
- package/README.md +17 -13
- package/SUPPORT.md +3 -2
- package/docs/config/fully-hosted.md +1 -1
- package/docs/config/hosted-models.md +1 -1
- package/docs/configuration.md +5 -5
- package/package.json +5 -1
package/CHANGELOG.md
CHANGED
|
@@ -9,6 +9,12 @@ This project uses npm package versions for release tracking:
|
|
|
9
9
|
|
|
10
10
|
## Unreleased
|
|
11
11
|
|
|
12
|
+
## 0.4.2
|
|
13
|
+
|
|
14
|
+
- Republished the core package from current `main` so the npm package README uses GitHub documentation links instead of stale jsDelivr links.
|
|
15
|
+
|
|
16
|
+
## 0.4.1
|
|
17
|
+
|
|
12
18
|
- Public OSS readiness cleanup: package metadata, support docs, public maintainer ownership, package tarball hygiene, and privacy/transcript-capture documentation.
|
|
13
19
|
- Added package verification CI and a privacy-first quickstart for local storage/local model setups.
|
|
14
20
|
|
package/CODE_OF_CONDUCT.md
CHANGED
|
@@ -45,7 +45,7 @@ or harmful.
|
|
|
45
45
|
## Scope
|
|
46
46
|
|
|
47
47
|
This Code of Conduct applies within all community spaces (issues, PRs,
|
|
48
|
-
|
|
48
|
+
Discord/Slack if any), and also applies when an individual is
|
|
49
49
|
officially representing the community in public spaces.
|
|
50
50
|
|
|
51
51
|
## Enforcement
|
package/CONTRIBUTING.md
CHANGED
|
@@ -199,7 +199,7 @@ Configure a fallback chain via `llm.fallback_provider` in config (or
|
|
|
199
199
|
|
|
200
200
|
## License
|
|
201
201
|
|
|
202
|
-
By contributing, you agree that your contributions will be licensed under the project's [AGPL-3.0-or-later](LICENSE) license.
|
|
202
|
+
By contributing, you agree that your contributions will be licensed under the project's [AGPL-3.0-or-later](https://github.com/bikky-dev/bikky/blob/main/LICENSE) license.
|
|
203
203
|
|
|
204
204
|
## Code of conduct
|
|
205
205
|
|
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ bikky gives AI coding agents (GitHub Copilot, Claude Code, Cursor, and other MCP
|
|
|
10
10
|
- 🤖 **Multi-agent engineering workflows** — Multiple Cursor / Claude Code / Copilot sessions can share codebase context, conventions, and recent decisions instead of re-learning them from scratch.
|
|
11
11
|
|
|
12
12
|
<p align="center">
|
|
13
|
-
<img src="https://
|
|
13
|
+
<img src="https://raw.githubusercontent.com/bikky-dev/bikky/main/docs/diagrams/team-memory.svg" alt="Memory — facts flow from individual sessions into a self-curating knowledge store shared across your team" width="720" />
|
|
14
14
|
</p>
|
|
15
15
|
|
|
16
16
|
<p align="center"><i>Knowledge flows from every session into a store that curates itself over time — deduplicating, distilling, and decaying stale facts — so every future session starts smarter across the team.</i></p>
|
|
@@ -165,15 +165,15 @@ Most installs use one Qdrant destination. If you need clean separation later, re
|
|
|
165
165
|
|
|
166
166
|
That is enough for explicit selection in the UI and tools. Add routing rules only when you want automatic placement by cwd, entity, content, or metadata. Search tools can also use `search_scope: "all"` or a named/listed scope when context may span stores. Existing single-Qdrant configs continue to work.
|
|
167
167
|
|
|
168
|
-
> 📖 **Details:** [multi-destination configuration](docs/configuration.md#multi-destination-routing)
|
|
168
|
+
> 📖 **Details:** [multi-destination configuration](https://github.com/bikky-dev/bikky/blob/main/docs/configuration.md#multi-destination-routing)
|
|
169
169
|
|
|
170
|
-
[fully-hosted-config]: https://
|
|
171
|
-
[hosted-models-config]: https://
|
|
172
|
-
[local-config]: https://
|
|
173
|
-
[hosted-qdrant-local-models-config]: https://
|
|
174
|
-
[configuration-guide]: https://
|
|
175
|
-
[privacy-quickstart]: https://
|
|
176
|
-
[contributing]: https://
|
|
170
|
+
[fully-hosted-config]: https://github.com/bikky-dev/bikky/blob/main/docs/config/fully-hosted.md
|
|
171
|
+
[hosted-models-config]: https://github.com/bikky-dev/bikky/blob/main/docs/config/hosted-models.md
|
|
172
|
+
[local-config]: https://github.com/bikky-dev/bikky/blob/main/docs/config/local.md
|
|
173
|
+
[hosted-qdrant-local-models-config]: https://github.com/bikky-dev/bikky/blob/main/docs/config/hosted-qdrant-local-models.md
|
|
174
|
+
[configuration-guide]: https://github.com/bikky-dev/bikky/blob/main/docs/configuration.md
|
|
175
|
+
[privacy-quickstart]: https://github.com/bikky-dev/bikky/blob/main/docs/privacy-first.md
|
|
176
|
+
[contributing]: https://github.com/bikky-dev/bikky/blob/main/CONTRIBUTING.md
|
|
177
177
|
|
|
178
178
|
---
|
|
179
179
|
|
|
@@ -189,17 +189,17 @@ bikky-ui # opens http://localhost:1422
|
|
|
189
189
|
```
|
|
190
190
|
|
|
191
191
|
<p align="center">
|
|
192
|
-
<img src="docs/screenshots/dashboard.png" alt="Dashboard — overview stats, category breakdown, recent facts" width="720" />
|
|
192
|
+
<img src="https://raw.githubusercontent.com/bikky-dev/bikky/main/docs/screenshots/dashboard.png" alt="Dashboard — overview stats, category breakdown, recent facts" width="720" />
|
|
193
193
|
</p>
|
|
194
194
|
<p align="center"><i>Dashboard — memory stats, category breakdown, and recent facts at a glance</i></p>
|
|
195
195
|
|
|
196
196
|
<p align="center">
|
|
197
|
-
<img src="docs/screenshots/memory.png" alt="Memory browser — search, filter, and browse all stored facts" width="720" />
|
|
197
|
+
<img src="https://raw.githubusercontent.com/bikky-dev/bikky/main/docs/screenshots/memory.png" alt="Memory browser — search, filter, and browse all stored facts" width="720" />
|
|
198
198
|
</p>
|
|
199
199
|
<p align="center"><i>Memory browser — search, filter by category/kind/source, and browse all stored facts</i></p>
|
|
200
200
|
|
|
201
201
|
<p align="center">
|
|
202
|
-
<img src="docs/screenshots/graph.png" alt="Entity graph — interactive visualization of entity relationships" width="720" />
|
|
202
|
+
<img src="https://raw.githubusercontent.com/bikky-dev/bikky/main/docs/screenshots/graph.png" alt="Entity graph — interactive visualization of entity relationships" width="720" />
|
|
203
203
|
</p>
|
|
204
204
|
<p align="center"><i>Entity graph — interactive visualization of how concepts, people, and services relate</i></p>
|
|
205
205
|
|
|
@@ -242,6 +242,10 @@ You can also set `daemon.extract_every_sec` to `0` to disable background extract
|
|
|
242
242
|
|
|
243
243
|
For a local-storage, local-model setup that minimizes what leaves your machine, see the [privacy-first quickstart][privacy-quickstart].
|
|
244
244
|
|
|
245
|
+
## Support and contact
|
|
246
|
+
|
|
247
|
+
For questions, bugs, and feature requests, please use [GitHub issues](https://github.com/bikky-dev/bikky/issues). For maintainer contact, reach Saber Zrelli on GitHub: [@zrelli-s](https://github.com/zrelli-s).
|
|
248
|
+
|
|
245
249
|
## License
|
|
246
250
|
|
|
247
|
-
AGPL-3.0 — see [LICENSE](LICENSE).
|
|
251
|
+
AGPL-3.0 — see [LICENSE](https://github.com/bikky-dev/bikky/blob/main/LICENSE).
|
package/SUPPORT.md
CHANGED
|
@@ -12,11 +12,12 @@ bikky status
|
|
|
12
12
|
|
|
13
13
|
Please redact API keys, access tokens, local file contents, and any private transcript data before posting.
|
|
14
14
|
|
|
15
|
+
For maintainer contact, reach Saber Zrelli on GitHub: [@zrelli-s](https://github.com/zrelli-s).
|
|
16
|
+
|
|
15
17
|
## Bugs
|
|
16
18
|
|
|
17
19
|
Use the bug report template and include a minimal reproduction when possible. If the issue involves setup, include whether you installed with `npm install -g bikky`, `npx bikky`, or a local checkout.
|
|
18
20
|
|
|
19
21
|
## Security reports
|
|
20
22
|
|
|
21
|
-
Do not open a public issue for vulnerabilities. Follow [SECURITY.md](SECURITY.md) and use GitHub private vulnerability reporting.
|
|
22
|
-
|
|
23
|
+
Do not open a public issue for vulnerabilities. Follow [SECURITY.md](https://github.com/bikky-dev/bikky/blob/main/SECURITY.md) and use GitHub private vulnerability reporting.
|
|
@@ -54,4 +54,4 @@ bikky stop && bikky start
|
|
|
54
54
|
|
|
55
55
|
Then restart your editor so its MCP process reloads.
|
|
56
56
|
|
|
57
|
-
For Bedrock, Portkey, custom base URLs, or model-specific dimensions, see the [full configuration guide](
|
|
57
|
+
For Bedrock, Portkey, custom base URLs, or model-specific dimensions, see the [full configuration guide](https://github.com/bikky-dev/bikky/blob/main/docs/configuration.md).
|
|
@@ -47,4 +47,4 @@ bikky status
|
|
|
47
47
|
|
|
48
48
|
If you started from a fresh install, run `bikky setup` after writing the config, then restart your editor so its MCP process reloads.
|
|
49
49
|
|
|
50
|
-
For Bedrock, Portkey, custom base URLs, or model-specific dimensions, see the [full configuration guide](
|
|
50
|
+
For Bedrock, Portkey, custom base URLs, or model-specific dimensions, see the [full configuration guide](https://github.com/bikky-dev/bikky/blob/main/docs/configuration.md).
|
package/docs/configuration.md
CHANGED
|
@@ -32,12 +32,12 @@ If you know which path you want, start with the focused guide:
|
|
|
32
32
|
|
|
33
33
|
| Setup | Best for | Guide |
|
|
34
34
|
| ----------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------ |
|
|
35
|
-
| Fully hosted | Best performance and teams; managed vector storage and models | [Fully hosted config](config/fully-hosted.md) |
|
|
36
|
-
| Local Qdrant + hosted models | Local vector storage with hosted extraction and embedding | [Hosted models config](config/hosted-models.md) |
|
|
37
|
-
| Local and free | Local evaluation; quality depends on local models | [Local config guide](config/local.md) |
|
|
38
|
-
| Hosted Qdrant + local models | Shared vector storage while keeping model calls local | [Hosted Qdrant + local models](config/hosted-qdrant-local-models.md) |
|
|
35
|
+
| Fully hosted | Best performance and teams; managed vector storage and models | [Fully hosted config](https://github.com/bikky-dev/bikky/blob/main/docs/config/fully-hosted.md) |
|
|
36
|
+
| Local Qdrant + hosted models | Local vector storage with hosted extraction and embedding | [Hosted models config](https://github.com/bikky-dev/bikky/blob/main/docs/config/hosted-models.md) |
|
|
37
|
+
| Local and free | Local evaluation; quality depends on local models | [Local config guide](https://github.com/bikky-dev/bikky/blob/main/docs/config/local.md) |
|
|
38
|
+
| Hosted Qdrant + local models | Shared vector storage while keeping model calls local | [Hosted Qdrant + local models](https://github.com/bikky-dev/bikky/blob/main/docs/config/hosted-qdrant-local-models.md) |
|
|
39
39
|
|
|
40
|
-
Privacy-conscious users should also read the [privacy-first quickstart](privacy-first.md), which combines local Qdrant, local Ollama models, and transcript-capture disable controls.
|
|
40
|
+
Privacy-conscious users should also read the [privacy-first quickstart](https://github.com/bikky-dev/bikky/blob/main/docs/privacy-first.md), which combines local Qdrant, local Ollama models, and transcript-capture disable controls.
|
|
41
41
|
|
|
42
42
|
### Fully hosted
|
|
43
43
|
|
package/package.json
CHANGED
|
@@ -1,9 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "bikky",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"description": "Shared memory for AI coding sessions — MCP server + background daemon",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "AGPL-3.0-or-later",
|
|
7
|
+
"author": {
|
|
8
|
+
"name": "Saber Zrelli",
|
|
9
|
+
"url": "https://github.com/zrelli-s"
|
|
10
|
+
},
|
|
7
11
|
"repository": {
|
|
8
12
|
"type": "git",
|
|
9
13
|
"url": "git+https://github.com/bikky-dev/bikky.git"
|