Skip to content

Commit cb2eb7d

Browse files
committed
chore(release): merge dev into main — all audit fixes complete
2 parents 2965751 + 2168063 commit cb2eb7d

3 files changed

Lines changed: 54 additions & 5 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ labels: bug
66

77
## Environment
88

9-
- Weave version: [e.g. 0.1.0]
9+
- Weave version: [e.g. 1.0.0]
1010
- Python version: [e.g. 3.11.4]
1111
- OS: [e.g. macOS 14, Ubuntu 22.04]
1212
- Platform adapter in use: [e.g. claude_code, cursor, codex, windsurf]

‎README.md‎

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,18 @@ Weave ingests skills from AI coding tools (Claude Code, Cursor, Codex, Windsurf)
2121

2222
![Weave demo](https://raw.githubusercontent.com/Adityaraj0421/weave-compose/main/demo.gif)
2323

24-
<!-- demo.gif is generated by running: brew install vhs && vhs demo.tape -->
25-
<!-- Record and commit demo.gif to the repo root to activate this image. -->
24+
<details>
25+
<summary>Record your own terminal demo</summary>
2626

27-
> Record your own: `brew install vhs && vhs demo.tape`
27+
Install [VHS](https://github.com/charmbracelet/vhs) and run:
28+
29+
```bash
30+
brew install vhs
31+
vhs demo.tape
32+
```
33+
34+
The `demo.tape` script in the repo root records all five CLI commands and saves `demo.gif`.
35+
</details>
2836

2937
---
3038

@@ -102,13 +110,42 @@ weave query "build a feature" --top 2
102110

103111
---
104112

113+
## FAQ
114+
115+
**Does Weave call any AI API or send data to the cloud?**
116+
No. Weave never calls any AI API. All embeddings run locally via `sentence-transformers`. No telemetry, no network calls after the model is cached.
117+
118+
**Where is my session stored?**
119+
In `.weave_session.json` in your current working directory. It is created by `weave load` and read by `weave query`, `weave list`, and `weave status`. It is never committed — it is in `.gitignore` by default.
120+
121+
**Does it work offline?**
122+
Yes, after the first run. The embedding model (`all-MiniLM-L6-v2`, ~80 MB) is downloaded from HuggingFace on first use and cached at `~/.cache/huggingface/`. All subsequent runs are fully offline.
123+
124+
**Can I use Weave with Gemini CLI?**
125+
A Gemini CLI adapter is not yet included — the entry in `weave/core/adapters/` is a stub. It is the top community contribution priority. See [docs/adapters.md](docs/adapters.md) to write one.
126+
127+
**How do I add support for a custom platform?**
128+
Subclass `BaseAdapter` in `weave/core/adapters/`, implement `load(path)` and `detect(path)`, then register it in `weave/core/detector.py`. The full guide is in [docs/adapters.md](docs/adapters.md).
129+
130+
---
131+
132+
## Learn More
133+
134+
- [Full changelog](CHANGELOG.md) — every release, what changed and why
135+
- [GitHub Releases](https://github.com/Adityaraj0421/weave-compose/releases) — tagged release notes
136+
- [Known limitations](docs/limitations.md) — documented gaps before you file an issue
137+
- [Project roadmap](docs/roadmap.md) — what shipped and what's coming next
138+
139+
---
140+
105141
## Contributing
106142

107143
Contributions are welcome at every layer — new platform adapters, composition strategies, CLI improvements, and documentation.
108144

109145
- **Contributor guide:** [docs/contributing.md](docs/contributing.md)
110146
- **Writing a new adapter:** [docs/adapters.md](docs/adapters.md)
111147
- **Architecture overview:** [docs/architecture.md](docs/architecture.md)
148+
- **Inter-skill protocol spec:** [docs/protocol.md](docs/protocol.md)
112149

113150
All code must pass `pytest`, `ruff check .`, and `mypy --strict .` before merging.
114151

@@ -117,3 +154,7 @@ All code must pass `pytest`, `ruff check .`, and `mypy --strict .` before mergin
117154
## License
118155

119156
MIT — see [LICENSE](LICENSE).
157+
158+
---
159+
160+
See [CHANGELOG.md](CHANGELOG.md) for the full release history.

‎docs/architecture.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The `Skill` dataclass in `weave/core/schema.py` is the lingua franca of the enti
8484

8585
### Output Interfaces
8686

87-
The CLI (`weave/cli/main.py`, built with `typer`) is the primary interface in v0.1. It exposes `weave load`, `weave query`, `weave list`, `weave status`, `weave clear`, `weave detect`, and `weave run`. A local FastAPI server (`weave/server/`) and React UI (`ui/`) are added in Phase 4, but they consume the same selector + composer pipeline — the core is interface-agnostic.
87+
The CLI (`weave/cli/main.py`, built with `typer`) is the primary interface. It exposes `weave load`, `weave query`, `weave list`, `weave status`, `weave clear`, `weave detect`, `weave run`, and `weave serve`. A local FastAPI server (`weave/server/`) and React UI (`ui/`) are also available — all three consume the same selector + composer pipeline, making the core fully interface-agnostic.
8888

8989
---
9090

@@ -115,3 +115,11 @@ Tracing a single `weave query "design a button component"` call:
115115
```
116116

117117
**Key performance property:** embedding runs once at `weave load` time. `weave query` only embeds the short query string — not the skills. This makes repeated queries fast even with large skill registries.
118+
119+
---
120+
121+
## Inter-Skill Protocol
122+
123+
Phase 5 introduces an inter-skill protocol that allows skills to discover and call each other without human involvement. Skills advertise capabilities via a `weave.skill.json` sidecar manifest and can declare dependencies on other skills. The Weave runtime resolves dependencies at load time and injects dependency contexts at a lower weight alongside the primary skill.
124+
125+
See [docs/protocol.md](protocol.md) for the full protocol specification, JSON schema, and request/response format.

0 commit comments

Comments
 (0)