topchester-ai 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 ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Topchester 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,64 @@
1
+ # Topchester Agent
2
+
3
+ ## Overview
4
+
5
+ Topchester Agent is a terminal-native TUI coding agent tightly coupled to a committed project knowledge base. The normal workflow is to compile project knowledge first, then let the agent use that knowledge while planning, editing, checking drift, and updating the repository.
6
+
7
+ ## Knowledge Compiler
8
+
9
+ The current `topchester kb compile` command handles L1 file knowledge:
10
+
11
+ - Requires `topchester kb init` to create the knowledge folders first.
12
+ - Reads workspace `.gitignore` files, lists in-scope project files, and skips generated/cache folders such as `.git/`, `node_modules/`, `dist/`, `coverage/`, `topchester-kb/`, `.agents/topchester/`, and `.agents/topchester-kb-cache/`.
13
+ - Queues L1 work at `.agents/topchester-kb-cache/l1-queue.json`.
14
+ - Processes queued files with the configured `kb.summarize` model, or `fallback` when `kb.summarize` is not configured.
15
+ - Writes the manifest at `topchester-kb/manifest.json`.
16
+ - Writes current L1 file entries under `topchester-kb/l1-files/`.
17
+ - Exits successfully only when every in-scope file has a current L1 entry.
18
+
19
+ ## Setup
20
+
21
+ - Node.js: `>=24`
22
+ - pnpm: `>=11`
23
+ - Package manager: `pnpm@11.0.8`
24
+
25
+ Install dependencies with:
26
+
27
+ ```sh
28
+ pnpm install
29
+ ```
30
+
31
+ ## Common Commands
32
+
33
+ ```sh
34
+ pnpm check
35
+ pnpm test
36
+ pnpm typecheck
37
+ pnpm lint
38
+ pnpm format-check
39
+
40
+ topchester kb init
41
+ topchester kb compile
42
+ topchester kb status
43
+ topchester kb reset
44
+ ```
45
+
46
+ ## Configuration
47
+
48
+ Model settings are loaded from YAML config files and merged in this order:
49
+
50
+ 1. `~/.config/topchester/config.yaml`
51
+ 2. `topchester.yaml`
52
+ 3. `.topchester/config.local.yaml`
53
+ 4. `TOPCHESTER_CONFIG`
54
+ 5. `--config <path>`
55
+
56
+ Example configs live in `config/example.yaml` and `config/gemini.yaml`. OpenRouter configs expect `OPENROUTER_API_KEY` in the environment; do not commit API keys or other secrets.
57
+
58
+ ## Docs
59
+
60
+ - [Architecture](docs/ARCHITECTURE.md)
61
+ - [Knowledge System](docs/KNOWLEDGE.md)
62
+ - [CLI Commands](docs/cli.md)
63
+ - [Model Configuration](docs/MODEL_CONFIG.md)
64
+ - [Sessions](docs/SESSIONS.md)
package/dist/cli.d.mts ADDED
@@ -0,0 +1 @@
1
+ export { };