scopecairn 0.1.0
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 +52 -0
- package/dist/cli.js +2423 -0
- package/package.json +48 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ScopeCairn Contributors
|
|
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
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# ScopeCairn
|
|
2
|
+
|
|
3
|
+
Local-first codebase intelligence layer for AI coding agents.
|
|
4
|
+
Builds a knowledge graph of your repository, retrieves only the context
|
|
5
|
+
relevant to the current task, analyzes change impact, and enforces
|
|
6
|
+
minimal-work scope. No MCP server, no embeddings, no network calls.
|
|
7
|
+
|
|
8
|
+
> Understand before exploring. Retrieve before reading.
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install -g scopecairn
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Requires Node.js ≥ 20.
|
|
17
|
+
|
|
18
|
+
## Quickstart
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
cd your-repo
|
|
22
|
+
scopecairn init # index + generate AGENTS.md, Skill, Workflow
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
After setup, your agent calls ScopeCairn automatically on every coding task.
|
|
26
|
+
To query manually:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
scopecairn context "add approval workflow"
|
|
30
|
+
scopecairn impact src/request/RequestService.ts
|
|
31
|
+
scopecairn read symbol approveRequest
|
|
32
|
+
scopecairn graph RequestService
|
|
33
|
+
scopecairn doctor
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Commands
|
|
37
|
+
|
|
38
|
+
| Command | Description |
|
|
39
|
+
|---|---|
|
|
40
|
+
| `init` | Initial indexing + generate `AGENTS.md`, Skill, Workflow |
|
|
41
|
+
| `scan` / `rebuild` / `clean` | Manual index management |
|
|
42
|
+
| `status` / `doctor` | Index status and health checks |
|
|
43
|
+
| `context "<task>"` | Main entry point: context + scope (`--escalate`, `--no-refresh`) |
|
|
44
|
+
| `impact <path\|symbol>` | Change impact analysis |
|
|
45
|
+
| `graph <symbol>` | Symbol relations |
|
|
46
|
+
| `query "<text>"` | Symbol search |
|
|
47
|
+
| `read symbol <name>` | Symbol-level source excerpt |
|
|
48
|
+
| `benchmark [--tune]` | Retrieval recall and weight calibration |
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
|
|
52
|
+
MIT — see [LICENSE](./LICENSE).
|