@knightcodeai/cli-linux-arm64 0.9.1 → 0.9.3
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/bin/CHANGELOG.md +60 -0
- package/bin/README.md +52 -19
- package/bin/docs/cli-integration.md +106 -0
- package/bin/docs/cli.md +270 -0
- package/bin/docs/compaction.md +56 -37
- package/bin/docs/configuration.md +46 -0
- package/bin/docs/containerization.md +86 -54
- package/bin/docs/custom-provider.md +132 -785
- package/bin/docs/docs.json +143 -103
- package/bin/docs/environment-variables.md +5 -4
- package/bin/docs/extensions.md +134 -2956
- package/bin/docs/how-knightcode-works.md +49 -0
- package/bin/docs/index.md +24 -69
- package/bin/docs/json.md +193 -65
- package/bin/docs/keybindings.md +56 -101
- package/bin/docs/llama-cpp.md +3 -3
- package/bin/docs/message-types.md +261 -0
- package/bin/docs/models.md +64 -547
- package/bin/docs/packages.md +66 -167
- package/bin/docs/prompt-templates.md +31 -68
- package/bin/docs/providers.md +103 -241
- package/bin/docs/quickstart.md +61 -106
- package/bin/docs/rpc-commands.md +854 -0
- package/bin/docs/rpc-extension-ui.md +200 -0
- package/bin/docs/rpc.md +129 -1556
- package/bin/docs/sdk.md +76 -1160
- package/bin/docs/security.md +70 -32
- package/bin/docs/session-format.md +25 -216
- package/bin/docs/sessions.md +38 -143
- package/bin/docs/settings.md +111 -389
- package/bin/docs/shell-aliases.md +85 -5
- package/bin/docs/skills.md +51 -189
- package/bin/docs/slash-commands.md +63 -0
- package/bin/docs/terminal-setup.md +107 -79
- package/bin/docs/termux.md +74 -83
- package/bin/docs/themes.md +68 -280
- package/bin/docs/tmux.md +31 -39
- package/bin/docs/tui.md +69 -923
- package/bin/docs/usage.md +79 -286
- package/bin/docs/windows.md +43 -17
- package/bin/export-html/template.js +6 -1
- package/bin/knightcode +2 -2
- package/bin/package.json +6 -6
- package/package.json +1 -1
- package/bin/docs/development.md +0 -71
package/bin/docs/development.md
DELETED
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
# Development
|
|
2
|
-
|
|
3
|
-
See [AGENTS.md](https://github.com/KnightCodeAI/knightcode/blob/main/AGENTS.md) for additional guidelines.
|
|
4
|
-
|
|
5
|
-
## Setup
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
git clone https://github.com/KnightCodeAI/knightcode
|
|
9
|
-
cd knightcode
|
|
10
|
-
npm install
|
|
11
|
-
npm run build
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
Run from source:
|
|
15
|
-
|
|
16
|
-
```bash
|
|
17
|
-
/path/to/knightcode/knightcode-test.sh
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
The script can be run from any directory. KnightCode keeps the caller's current working directory.
|
|
21
|
-
|
|
22
|
-
## Forking / Rebranding
|
|
23
|
-
|
|
24
|
-
Configure via `package.json`:
|
|
25
|
-
|
|
26
|
-
```json
|
|
27
|
-
{
|
|
28
|
-
"piConfig": {
|
|
29
|
-
"name": "knightcode",
|
|
30
|
-
"configDir": ".knightcode"
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
Change `name`, `configDir`, and `bin` field for your fork. Affects CLI banner, config paths, and environment variable names.
|
|
36
|
-
|
|
37
|
-
## Path Resolution
|
|
38
|
-
|
|
39
|
-
Three execution modes: npm install, standalone binary, tsx from source.
|
|
40
|
-
|
|
41
|
-
**Always use `src/config.ts`** for package assets:
|
|
42
|
-
|
|
43
|
-
```typescript
|
|
44
|
-
import { getPackageDir, getThemeDir } from "./config.js";
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
Never use `__dirname` directly for package assets.
|
|
48
|
-
|
|
49
|
-
## Debug Command
|
|
50
|
-
|
|
51
|
-
`/debug` (hidden) writes to `~/.knightcode/agent/knightcode-debug.log`:
|
|
52
|
-
- Rendered TUI lines with ANSI codes
|
|
53
|
-
- Last messages sent to the LLM
|
|
54
|
-
|
|
55
|
-
## Testing
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
./test.sh # Run non-LLM tests (no API keys needed)
|
|
59
|
-
npm test # Run all tests
|
|
60
|
-
npm test -- test/specific.test.ts # Run specific test
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## Project Structure
|
|
64
|
-
|
|
65
|
-
```
|
|
66
|
-
packages/
|
|
67
|
-
ai/ # LLM provider abstraction
|
|
68
|
-
agent/ # Agent loop and message types
|
|
69
|
-
tui/ # Terminal UI components
|
|
70
|
-
coding-agent/ # CLI and interactive mode
|
|
71
|
-
```
|