openace 0.1.0 → 0.1.5
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 +80 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# OpenACE
|
|
2
|
+
|
|
3
|
+
AI-native Contextual Code Engine. Multi-signal semantic code search via MCP for Claude Code, Codex CLI, and any MCP-compatible client.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g openace
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Use with Claude Code
|
|
12
|
+
|
|
13
|
+
Add to your project's `.mcp.json`:
|
|
14
|
+
|
|
15
|
+
```json
|
|
16
|
+
{
|
|
17
|
+
"mcpServers": {
|
|
18
|
+
"openace": {
|
|
19
|
+
"command": "npx",
|
|
20
|
+
"args": ["-y", "openace", "serve", ".", "--embedding", "siliconflow"],
|
|
21
|
+
"env": {
|
|
22
|
+
"OPENACE_EMBEDDING_API_KEY": "your-api-key"
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Use with Codex CLI
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
codex mcp add openace -- npx -y openace serve . --embedding siliconflow
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Commands
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
# Start MCP server (default)
|
|
39
|
+
openace serve /path/to/project --embedding siliconflow
|
|
40
|
+
|
|
41
|
+
# Index a project
|
|
42
|
+
openace index /path/to/project --embedding siliconflow
|
|
43
|
+
|
|
44
|
+
# Search
|
|
45
|
+
openace search "user authentication" -p /path/to/project
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## MCP Tools
|
|
49
|
+
|
|
50
|
+
- **semantic_search** — Search code by natural language query with ranked results and snippets
|
|
51
|
+
- **find_symbol** — Look up symbols by exact name
|
|
52
|
+
- **get_file_outline** — Get structural overview of a file
|
|
53
|
+
|
|
54
|
+
## How It Works
|
|
55
|
+
|
|
56
|
+
This npm package is a thin wrapper that delegates to the Python `openace` package via [`uvx`](https://docs.astral.sh/uv/). The Rust+Python engine provides:
|
|
57
|
+
|
|
58
|
+
- Multi-signal retrieval: BM25 + vector kNN + exact match + graph expansion + AST chunks
|
|
59
|
+
- Reciprocal Rank Fusion (RRF) for high-quality ranking
|
|
60
|
+
- CJK bigram tokenization for Chinese/Japanese/Korean queries
|
|
61
|
+
- Support for Python, TypeScript, JavaScript, Rust, Go, Java
|
|
62
|
+
|
|
63
|
+
## Prerequisites
|
|
64
|
+
|
|
65
|
+
- [`uv`](https://docs.astral.sh/uv/) must be installed (`pip install uv` or `curl -LsSf https://astral.sh/uv/install.sh | sh`)
|
|
66
|
+
|
|
67
|
+
## Custom API Providers
|
|
68
|
+
|
|
69
|
+
Supports any OpenAI-compatible embedding/reranking API:
|
|
70
|
+
|
|
71
|
+
| Variable | Description |
|
|
72
|
+
|----------|-------------|
|
|
73
|
+
| `OPENACE_EMBEDDING_API_KEY` | API key for embedding provider |
|
|
74
|
+
| `OPENACE_EMBEDDING_BASE_URL` | Custom base URL for embedding API |
|
|
75
|
+
| `OPENACE_RERANKER_API_KEY` | API key for reranker provider |
|
|
76
|
+
| `OPENACE_RERANKER_BASE_URL` | Custom base URL for reranker API |
|
|
77
|
+
|
|
78
|
+
## License
|
|
79
|
+
|
|
80
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "openace",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.5",
|
|
4
4
|
"description": "AI-native Contextual Code Engine — semantic code search via MCP",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -18,7 +18,8 @@
|
|
|
18
18
|
"openace": "./bin/cli.mjs"
|
|
19
19
|
},
|
|
20
20
|
"files": [
|
|
21
|
-
"bin/"
|
|
21
|
+
"bin/",
|
|
22
|
+
"README.md"
|
|
22
23
|
],
|
|
23
24
|
"engines": {
|
|
24
25
|
"node": ">=18"
|