Skip to content

Commit 99f9186

Browse files
mareursclaude
andcommitted
docs: rename remaining code-explorer references to codescout
Updates CONTRIBUTING.md, CHANGELOG.md, scripts, tests, copilot instructions, issue template, and renames CODE-EXPLORER-EMBEDDINGS-SETUP.md. Preserves code-explorer-routing plugin name (separate project). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 80b1792 commit 99f9186

8 files changed

Lines changed: 31 additions & 31 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ labels: bug
2222

2323
- OS:
2424
- Rust version:
25-
- code-explorer version:
25+
- codescout version:
2626
- MCP client (e.g., Claude Code):

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ All notable changes to codescout are documented here.
44

55
## [0.2.0] — codescout
66

7-
> **TL;DR:** The project was renamed from `code-explorer` to `codescout`. If you're
7+
> **TL;DR:** The project was renamed from `codescout` to `codescout`. If you're
88
> migrating, update your MCP config and any scripts that reference the old binary name.
99
> [Full story and migration guide →](docs/manual/src/history.md)
1010
1111
### Breaking changes
1212

13-
- **Binary renamed:** `code-explorer``codescout`
13+
- **Binary renamed:** `codescout``codescout`
1414
- **MCP server ID renamed** — update `.mcp.json` or Claude Code settings accordingly
1515
- **Tool renames** (API consistency):
1616

@@ -198,7 +198,7 @@ All notable changes to codescout are documented here.
198198
- `check_onboarding_performed` — check if onboarding has run
199199

200200
### Infrastructure
201-
- `.mcp.json` — Claude Code MCP config for using code-explorer on its own source
201+
- `.mcp.json` — Claude Code MCP config for using codescout on its own source
202202
- 141 tests: 136 unit + 5 end-to-end integration tests
203203
- Integration tests cover: read→search→replace, AST analysis, memory+config roundtrip,
204204
git history creation, onboarding+explore

CLAUDE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -148,11 +148,11 @@ This project has a companion Claude Code plugin at **`../claude-plugins/code-exp
148148
The `PreToolUse` hook will **block** any attempt to use the native `Read`, `Grep`, or `Glob` tools on source code files (`.rs`, `.ts`, `.py`, etc). You will see `PreToolUse:Read hook error` if you try.
149149

150150
**You MUST use codescout's own MCP tools to read source code:**
151-
- `mcp__code-explorer__list_symbols(path)` — see all symbols in a file/dir
152-
- `mcp__code-explorer__find_symbol(name, include_body=true)` — read a function body
153-
- `mcp__code-explorer__search_pattern(pattern)` — regex search
154-
- `mcp__code-explorer__semantic_search(query)` — concept-level search
155-
- `mcp__code-explorer__read_file(path)` — for non-source files (markdown, toml, json)
151+
- `mcp__codescout__list_symbols(path)` — see all symbols in a file/dir
152+
- `mcp__codescout__find_symbol(name, include_body=true)` — read a function body
153+
- `mcp__codescout__search_pattern(pattern)` — regex search
154+
- `mcp__codescout__semantic_search(query)` — concept-level search
155+
- `mcp__codescout__read_file(path)` — for non-source files (markdown, toml, json)
156156

157157
**Configuration:**
158158
- Auto-detects codescout from `.mcp.json` or `~/.claude/settings.json`
Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Code Explorer — Embedding Setup on WSL2 Behind Zscaler
22

33
This document captures the full journey of getting semantic search working in
4-
`code-explorer` on a WSL2 machine behind a Zscaler corporate proxy. It is
4+
`codescout` on a WSL2 machine behind a Zscaler corporate proxy. It is
55
written as a troubleshooting narrative so that future developers can skip the
66
trial-and-error and go straight to the working solution.
77

@@ -13,7 +13,7 @@ trial-and-error and go straight to the working solution.
1313
|---|---|
1414
| OS | Ubuntu on WSL2 (Windows host) |
1515
| Network proxy | Zscaler (SSL-inspecting corporate proxy) |
16-
| Tool | `code-explorer` MCP server (built from source) |
16+
| Tool | `codescout` MCP server (built from source) |
1717
| Target | `local:AllMiniLML6V2Q` — CPU-only, INT8-quantized, ~22 MB |
1818

1919
---
@@ -24,19 +24,19 @@ trial-and-error and go straight to the working solution.
2424

2525
```
2626
The local embedding model isn't available in this environment. The
27-
code-explorer server was built without the local-embed feature, so
27+
codescout server was built without the local-embed feature, so
2828
semantic search isn't supported here.
2929
```
3030

3131
### Cause
3232

33-
`code-explorer` has an optional Cargo feature `local-embed` that pulls in
33+
`codescout` has an optional Cargo feature `local-embed` that pulls in
3434
`fastembed-rs` and the ONNX Runtime. The default build omits it.
3535

3636
### Fix
3737

3838
```bash
39-
cd /home/vradu/work/tools/code-explorer
39+
cd /home/vradu/work/tools/codescout
4040
git pull
4141
cargo install --path . --features local-embed
4242
```
@@ -125,7 +125,7 @@ Missing Input: encoder.layer.0.attention.output.LayerNorm.weight
125125

126126
### Cause
127127

128-
`code-explorer` statically links ORT 1.20.0 via the `ort-download-binaries`
128+
`codescout` statically links ORT 1.20.0 via the `ort-download-binaries`
129129
Cargo feature. The Qdrant model `Qdrant/bge-small-en-v1.5-onnx-Q` was
130130
exported with:
131131

@@ -173,10 +173,10 @@ not graph-fused operators.
173173

174174
### Step-by-step setup
175175

176-
**1. Rebuild code-explorer with local-embed** (if not already done)
176+
**1. Rebuild codescout with local-embed** (if not already done)
177177

178178
```bash
179-
cd /home/vradu/work/tools/code-explorer
179+
cd /home/vradu/work/tools/codescout
180180
cargo install --path . --features local-embed
181181
```
182182

@@ -284,9 +284,9 @@ models, weights) are stored in XetHub LFS and always redirect to
284284
`cas-bridge.xethub.hf.co`, which Zscaler blocks. The workaround is to
285285
download from the Windows host browser and copy into WSL2.
286286

287-
### 4 — ORT is statically compiled into code-explorer
287+
### 4 — ORT is statically compiled into codescout
288288

289289
The `ort-download-binaries` Cargo feature downloads the ORT binary at build
290290
time and links it statically. You cannot swap the ORT runtime at runtime via
291291
`LD_PRELOAD` or environment variables. If a model requires a different ORT
292-
version, you must rebuild code-explorer targeting that version.
292+
version, you must rebuild codescout targeting that version.

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Contributing to code-explorer
1+
# Contributing to codescout
22

33
We welcome contributions! Whether it's a bug fix, new language support, or documentation improvement — we're happy to review it.
44

55
## Getting Started
66

77
```bash
8-
git clone https://github.com/mareurs/code-explorer.git
9-
cd code-explorer
8+
git clone https://github.com/mareurs/codescout.git
9+
cd codescout
1010
cargo build
1111
cargo test
1212
```
@@ -36,7 +36,7 @@ cargo test
3636

3737
## Using Claude Code?
3838

39-
PRs generated with Claude Code are welcome. Just mention it in the PR description. If you're using code-explorer itself as an MCP server while contributing to code-explorer — that's the dream. Let us know how it went.
39+
PRs generated with Claude Code are welcome. Just mention it in the PR description. If you're using codescout itself as an MCP server while contributing to codescout — that's the dream. Let us know how it went.
4040

4141
## Project Structure
4242

scripts/capture-screenshot.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ OUTPUT="$PROJECT_ROOT/docs/images/dashboard.png"
77
SCRIPTS_DIR="$PROJECT_ROOT/scripts"
88

99
# --- Check binary ---
10-
BINARY=$(command -v code-explorer 2>/dev/null || echo "$PROJECT_ROOT/target/release/code-explorer")
10+
BINARY=$(command -v codescout 2>/dev/null || echo "$PROJECT_ROOT/target/release/codescout")
1111
if [[ ! -x "$BINARY" ]]; then
12-
echo "ERROR: code-explorer binary not found."
12+
echo "ERROR: codescout binary not found."
1313
echo "Build it first: cargo build --release"
1414
exit 1
1515
fi

scripts/install-lsp.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env bash
22
#
3-
# Install LSP servers for code-explorer.
3+
# Install LSP servers for codescout.
44
#
55
# Usage:
66
# ./scripts/install-lsp.sh --check # show what's installed / missing
@@ -17,7 +17,7 @@ set -euo pipefail
1717
# ── Globals ──────────────────────────────────────────────────────────────────
1818

1919
INSTALL_DIR="${HOME}/.local/bin"
20-
DOWNLOAD_DIR="${TMPDIR:-/tmp}/code-explorer-lsp-install"
20+
DOWNLOAD_DIR="${TMPDIR:-/tmp}/codescout-lsp-install"
2121

2222
ALL_LANGS=(rust python typescript go java kotlin c csharp ruby)
2323

@@ -382,7 +382,7 @@ usage() {
382382
cat <<EOF
383383
Usage: $(basename "$0") [OPTIONS] [LANGUAGES...]
384384
385-
Install LSP servers for code-explorer.
385+
Install LSP servers for codescout.
386386
387387
Options:
388388
--check Show which LSP servers are installed / missing

tests/mcp-smoke-kotlin.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/usr/bin/env bash
2-
# End-to-end MCP smoke test for code-explorer against a Kotlin project.
2+
# End-to-end MCP smoke test for codescout against a Kotlin project.
33
# Calls the real binary over stdio via the `mcp` CLI tool.
44
# Run from the project root: ./tests/mcp-smoke-kotlin.sh
55
#
@@ -51,13 +51,13 @@ fail() {
5151

5252
# ── Setup ────────────────────────────────────────────────────────────────────
5353

54-
echo "Building code-explorer (release)..."
54+
echo "Building codescout (release)..."
5555
cargo build --release 2>&1 | tail -1
5656
echo "done"
5757
echo ""
5858

5959
export PATH="$HOME/.local/bin:$PATH"
60-
mcp alias add ce-kt-test ./target/release/code-explorer start --project "$KOTLIN_PROJECT"
60+
mcp alias add ce-kt-test ./target/release/codescout start --project "$KOTLIN_PROJECT"
6161

6262
cleanup() {
6363
mcp alias remove ce-kt-test 2>/dev/null || true

0 commit comments

Comments
 (0)