@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.
Files changed (45) hide show
  1. package/bin/CHANGELOG.md +60 -0
  2. package/bin/README.md +52 -19
  3. package/bin/docs/cli-integration.md +106 -0
  4. package/bin/docs/cli.md +270 -0
  5. package/bin/docs/compaction.md +56 -37
  6. package/bin/docs/configuration.md +46 -0
  7. package/bin/docs/containerization.md +86 -54
  8. package/bin/docs/custom-provider.md +132 -785
  9. package/bin/docs/docs.json +143 -103
  10. package/bin/docs/environment-variables.md +5 -4
  11. package/bin/docs/extensions.md +134 -2956
  12. package/bin/docs/how-knightcode-works.md +49 -0
  13. package/bin/docs/index.md +24 -69
  14. package/bin/docs/json.md +193 -65
  15. package/bin/docs/keybindings.md +56 -101
  16. package/bin/docs/llama-cpp.md +3 -3
  17. package/bin/docs/message-types.md +261 -0
  18. package/bin/docs/models.md +64 -547
  19. package/bin/docs/packages.md +66 -167
  20. package/bin/docs/prompt-templates.md +31 -68
  21. package/bin/docs/providers.md +103 -241
  22. package/bin/docs/quickstart.md +61 -106
  23. package/bin/docs/rpc-commands.md +854 -0
  24. package/bin/docs/rpc-extension-ui.md +200 -0
  25. package/bin/docs/rpc.md +129 -1556
  26. package/bin/docs/sdk.md +76 -1160
  27. package/bin/docs/security.md +70 -32
  28. package/bin/docs/session-format.md +25 -216
  29. package/bin/docs/sessions.md +38 -143
  30. package/bin/docs/settings.md +111 -389
  31. package/bin/docs/shell-aliases.md +85 -5
  32. package/bin/docs/skills.md +51 -189
  33. package/bin/docs/slash-commands.md +63 -0
  34. package/bin/docs/terminal-setup.md +107 -79
  35. package/bin/docs/termux.md +74 -83
  36. package/bin/docs/themes.md +68 -280
  37. package/bin/docs/tmux.md +31 -39
  38. package/bin/docs/tui.md +69 -923
  39. package/bin/docs/usage.md +79 -286
  40. package/bin/docs/windows.md +43 -17
  41. package/bin/export-html/template.js +6 -1
  42. package/bin/knightcode +2 -2
  43. package/bin/package.json +6 -6
  44. package/package.json +1 -1
  45. package/bin/docs/development.md +0 -71
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "navigation": [
3
3
  {
4
- "title": "Start here",
4
+ "title": "Get Started",
5
5
  "items": [
6
6
  {
7
7
  "title": "Overview",
@@ -12,146 +12,182 @@
12
12
  "path": "quickstart.md"
13
13
  },
14
14
  {
15
- "title": "Using KnightCode",
16
- "path": "usage.md"
17
- },
18
- {
19
- "title": "Providers",
20
- "path": "providers.md"
21
- },
22
- {
23
- "title": "Security",
24
- "path": "security.md"
25
- },
26
- {
27
- "title": "Containerization",
28
- "path": "containerization.md"
29
- },
30
- {
31
- "title": "Settings",
32
- "path": "settings.md"
33
- },
34
- {
35
- "title": "Keybindings",
36
- "path": "keybindings.md"
37
- },
38
- {
39
- "title": "Sessions",
40
- "path": "sessions.md"
41
- },
42
- {
43
- "title": "Remote sessions",
44
- "path": "remote.md"
45
- },
46
- {
47
- "title": "Compaction",
48
- "path": "compaction.md"
15
+ "title": "How KnightCode Works",
16
+ "path": "how-knightcode-works.md"
49
17
  }
50
18
  ]
51
19
  },
52
20
  {
53
- "title": "Customization",
21
+ "title": "Guides",
54
22
  "items": [
55
23
  {
56
- "title": "Extensions",
57
- "path": "extensions.md"
58
- },
24
+ "title": "Run KnightCode",
25
+ "items": [
26
+ {
27
+ "title": "Use KnightCode in the Terminal",
28
+ "path": "usage.md"
29
+ },
30
+ {
31
+ "title": "Choose a Model",
32
+ "path": "models.md"
33
+ },
34
+ {
35
+ "title": "Manage Sessions and Context",
36
+ "path": "sessions.md"
37
+ },
38
+ {
39
+ "title": "Use Remote Sessions",
40
+ "path": "remote.md"
41
+ },
42
+ {
43
+ "title": "Run KnightCode Safely",
44
+ "path": "security.md"
45
+ },
46
+ {
47
+ "title": "Isolate KnightCode",
48
+ "path": "containerization.md"
49
+ },
50
+ {
51
+ "title": "Run Local Models",
52
+ "path": "llama-cpp.md"
53
+ },
54
+ {
55
+ "title": "Configure Your Terminal",
56
+ "path": "terminal-setup.md"
57
+ },
58
+ {
59
+ "title": "Configure Shell Commands",
60
+ "path": "shell-aliases.md"
61
+ },
62
+ {
63
+ "title": "Run KnightCode in tmux",
64
+ "path": "tmux.md"
65
+ },
66
+ {
67
+ "title": "Run KnightCode on Windows",
68
+ "path": "windows.md"
69
+ },
70
+ {
71
+ "title": "Run KnightCode on Android",
72
+ "path": "termux.md"
73
+ }
74
+ ]
75
+ },
76
+ {
77
+ "title": "Customize KnightCode",
78
+ "items": [
79
+ {
80
+ "title": "Configure KnightCode",
81
+ "path": "configuration.md"
82
+ },
83
+ {
84
+ "title": "Create Prompt Templates",
85
+ "path": "prompt-templates.md"
86
+ },
87
+ {
88
+ "title": "Add Skills",
89
+ "path": "skills.md"
90
+ },
91
+ {
92
+ "title": "Create Themes",
93
+ "path": "themes.md"
94
+ },
95
+ {
96
+ "title": "Use KnightCode Packages",
97
+ "path": "packages.md"
98
+ }
99
+ ]
100
+ },
101
+ {
102
+ "title": "Build on KnightCode",
103
+ "items": [
104
+ {
105
+ "title": "Build Extensions",
106
+ "path": "extensions.md"
107
+ },
108
+ {
109
+ "title": "Add Custom Providers",
110
+ "path": "custom-provider.md"
111
+ },
112
+ {
113
+ "title": "Build Terminal UI Components",
114
+ "path": "tui.md"
115
+ },
116
+ {
117
+ "title": "Integrate with the CLI",
118
+ "path": "cli-integration.md"
119
+ },
120
+ {
121
+ "title": "Use the SDK",
122
+ "path": "sdk.md"
123
+ }
124
+ ]
125
+ }
126
+ ]
127
+ },
128
+ {
129
+ "title": "Reference",
130
+ "items": [
59
131
  {
60
- "title": "Skills",
61
- "path": "skills.md"
132
+ "title": "CLI",
133
+ "path": "cli.md"
62
134
  },
63
135
  {
64
- "title": "Prompt Templates",
65
- "path": "prompt-templates.md"
136
+ "title": "Slash Commands",
137
+ "path": "slash-commands.md"
66
138
  },
67
139
  {
68
- "title": "Themes",
69
- "path": "themes.md"
140
+ "title": "Settings",
141
+ "path": "settings.md"
70
142
  },
71
143
  {
72
- "title": "KnightCode Packages",
73
- "path": "packages.md"
144
+ "title": "Environment Variables",
145
+ "path": "environment-variables.md"
74
146
  },
75
147
  {
76
- "title": "Custom Models",
77
- "path": "models.md"
148
+ "title": "Keybindings",
149
+ "path": "keybindings.md"
78
150
  },
79
151
  {
80
- "title": "Custom Providers",
81
- "path": "custom-provider.md"
82
- }
83
- ]
84
- },
85
- {
86
- "title": "Reference",
87
- "items": [
88
- {
89
- "title": "Environment Variables",
90
- "path": "environment-variables.md"
152
+ "title": "Provider Authentication",
153
+ "path": "providers.md"
91
154
  },
92
155
  {
93
- "title": "Session Format",
156
+ "title": "Session File Format",
94
157
  "path": "session-format.md"
95
- }
96
- ]
97
- },
98
- {
99
- "title": "Programmatic Usage",
100
- "items": [
101
- {
102
- "title": "SDK",
103
- "path": "sdk.md"
104
158
  },
105
159
  {
106
- "title": "RPC Mode",
107
- "path": "rpc.md"
160
+ "title": "Compaction and Branch Summaries",
161
+ "path": "compaction.md"
108
162
  },
109
163
  {
110
- "title": "JSON Event Stream Mode",
164
+ "title": "JSON Event Stream",
111
165
  "path": "json.md"
112
166
  },
113
167
  {
114
- "title": "TUI Components",
115
- "path": "tui.md"
116
- }
117
- ]
118
- },
119
- {
120
- "title": "Platform Setup",
121
- "items": [
122
- {
123
- "title": "Windows",
124
- "path": "windows.md"
125
- },
126
- {
127
- "title": "Termux on Android",
128
- "path": "termux.md"
168
+ "title": "RPC Protocol",
169
+ "path": "rpc.md"
129
170
  },
130
171
  {
131
- "title": "tmux",
132
- "path": "tmux.md"
172
+ "title": "RPC Commands",
173
+ "path": "rpc-commands.md"
133
174
  },
134
175
  {
135
- "title": "Terminal Setup",
136
- "path": "terminal-setup.md"
176
+ "title": "RPC Extension UI",
177
+ "path": "rpc-extension-ui.md"
137
178
  },
138
179
  {
139
- "title": "Shell Aliases",
140
- "path": "shell-aliases.md"
141
- }
142
- ]
143
- },
144
- {
145
- "title": "Development",
146
- "items": [
147
- {
148
- "title": "Development",
149
- "path": "development.md"
180
+ "title": "Message Types",
181
+ "path": "message-types.md"
150
182
  }
151
183
  ]
152
184
  }
153
185
  ],
154
186
  "redirects": [
187
+ {
188
+ "from": "development.md",
189
+ "to": "index.md"
190
+ },
155
191
  {
156
192
  "from": "session.md",
157
193
  "to": "session-format.md"
@@ -159,6 +195,10 @@
159
195
  {
160
196
  "from": "tree.md",
161
197
  "to": "sessions.md"
198
+ },
199
+ {
200
+ "from": "process-integration.md",
201
+ "to": "cli-integration.md"
162
202
  }
163
203
  ]
164
204
  }
@@ -6,7 +6,7 @@ KnightCode uses environment variables in three ways:
6
6
  - KnightCode sets process markers so child processes can identify KnightCode as the launching agent.
7
7
  - Commands run by the LLM-callable shell tools receive `KNIGHTCODE_*` variables describing the current session.
8
8
 
9
- Provider API-key variables are documented separately in [Providers](providers.md#environment-variables-or-auth-file).
9
+ Provider API-key variables are documented separately in [Provider Authentication](providers.md#use-an-api-key-from-the-environment).
10
10
 
11
11
  ## Process Marker
12
12
 
@@ -83,13 +83,14 @@ These variables are read by KnightCode itself:
83
83
  | `KNIGHTCODE_PACKAGE_DIR` | Override the package directory, useful for Nix/Guix store paths |
84
84
  | `KNIGHTCODE_SERVER_DIR` | Override the experimental server profile and socket directory; default is `~/.knightcode/server` |
85
85
  | `KNIGHTCODE_SERVER_ID` | Select the logical experimental server ID when `--server-id` is omitted |
86
- | `KNIGHTCODE_OFFLINE` | Disable startup network operations, including update checks, package updates, and install/update telemetry |
86
+ | `KNIGHTCODE_OFFLINE` | Disable automatic network activity, including model catalog refreshes |
87
87
  | `KNIGHTCODE_DISABLE_FILE_CHECKPOINTS` | Set to `1`, `true`, or `yes` to stop backing up files before edits; `/undo` then rewinds the conversation only. See [Sessions](sessions.md#file-restore) |
88
88
  | `KNIGHTCODE_SKIP_VERSION_CHECK` | Disable the `knightcode.dev` latest-version request |
89
89
  | `KNIGHTCODE_TELEMETRY` | Override install/update telemetry and provider attribution headers: `1`/`true`/`yes` or `0`/`false`/`no` |
90
90
  | `KNIGHTCODE_CACHE_RETENTION` | Set to `long` for extended provider prompt caching where supported |
91
91
  | `KNIGHTCODE_SHARE_VIEWER_URL` | Override the base URL used by `/share` |
92
- | `KNIGHTCODE_RADIUS_GATEWAY` | Override the Radius gateway origin used by `/bug` uploads and Radius relay connections |
92
+ | `KNIGHTCODE_BUG_ENDPOINT` | Override the origin `/bug` uploads go to; default is `https://remote.knightcode.dev` |
93
+ | `KNIGHTCODE_RADIUS_GATEWAY` | Override the Radius gateway origin used by Radius relay connections |
93
94
  | `KNIGHTCODE_HARDWARE_CURSOR` | Set to `1` to show the hardware cursor; see [Terminal setup](terminal-setup.md) |
94
95
  | `KNIGHTCODE_HYPERLINKS` | Override OSC 8 hyperlink detection with `1`, `0`, or `auto` |
95
96
  | `KNIGHTCODE_IMAGE_PROTOCOL` | Override inline image detection with `kitty`, `iterm2`, `none`, or `auto` |
@@ -99,4 +100,4 @@ These variables are read by KnightCode itself:
99
100
  | `VISUAL`, `EDITOR` | External editor fallback when `externalEditor` is unset |
100
101
  | `HTTP_PROXY`, `HTTPS_PROXY` | Proxy outbound HTTP requests |
101
102
 
102
- Provider credentials such as `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, and cloud-provider configuration are listed in [Providers](providers.md#environment-variables-or-auth-file).
103
+ Provider credentials such as `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, and cloud-provider configuration are listed in [Provider Authentication](providers.md#use-an-api-key-from-the-environment).