doc discrepancy fixes
This commit is contained in:
@@ -110,11 +110,9 @@ dependencies beyond libc, libcurl and libreadline.
|
|||||||
|
|
||||||
## Running
|
## Running
|
||||||
|
|
||||||
All implementations read `model.cfg` (or `.bantam.cfg`, which takes priority
|
Bantam reads `.bantam.cfg` from the current working directory.
|
||||||
if present) from the current working directory.
|
|
||||||
|
|
||||||
1. Configure `model.cfg` (or `.bantam.cfg`, which takes priority) with your
|
1. Configure `.bantam.cfg` with your API settings:
|
||||||
API settings:
|
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
endpoint=https://api.kilo.ai/api/openrouter
|
endpoint=https://api.kilo.ai/api/openrouter
|
||||||
@@ -138,8 +136,8 @@ if present) from the current working directory.
|
|||||||
to submit the whole multi-line prompt. Bracketed paste is enabled
|
to submit the whole multi-line prompt. Bracketed paste is enabled
|
||||||
(`ESC[?2004h`) while editing, so a multi-line block pasted from the
|
(`ESC[?2004h`) while editing, so a multi-line block pasted from the
|
||||||
clipboard is inserted as literal line breaks and only the final **Enter**
|
clipboard is inserted as literal line breaks and only the final **Enter**
|
||||||
submits it. The C++ port ships its own raw-mode line editor, working
|
submits it. The interactive prompt is provided by **GNU readline**, which
|
||||||
everywhere with no third-party dependencies. It supports arrow keys and
|
is a third-party dependency (see Prerequisites). It supports arrow keys and
|
||||||
Up/Down for history, Backspace / Delete / Ctrl+D (on an empty line) to
|
Up/Down for history, Backspace / Delete / Ctrl+D (on an empty line) to
|
||||||
delete, and Emacs-style editing combos: **Ctrl+A** (start of line),
|
delete, and Emacs-style editing combos: **Ctrl+A** (start of line),
|
||||||
**Ctrl+E** (end of line), **Ctrl+B** / **Ctrl+F** (move by character),
|
**Ctrl+E** (end of line), **Ctrl+B** / **Ctrl+F** (move by character),
|
||||||
@@ -219,11 +217,10 @@ if present) from the current working directory.
|
|||||||
|
|
||||||
## Model configuration parameters
|
## Model configuration parameters
|
||||||
|
|
||||||
(shared with the Go and C implementations; `.bantam.cfg` takes priority over
|
(shared with the Go and C implementations; the configuration file is
|
||||||
`model.cfg` when both exist — both are plain `key=value` with `#` comments.
|
`.bantam.cfg` — a plain `key=value` file with `#` comments. Values defined in
|
||||||
Values defined in `.bantam.cfg` override `BANTAM_*` environment variables;
|
`.bantam.cfg` override `BANTAM_*` environment variables; when `.bantam.cfg`
|
||||||
when `.bantam.cfg` is absent, `BANTAM_*` environment variables override
|
is absent, `BANTAM_*` environment variables override the built-in defaults.)
|
||||||
`model.cfg` and built-in defaults.)
|
|
||||||
|
|
||||||
- `endpoint` (base OpenAI-compatible API URL, default
|
- `endpoint` (base OpenAI-compatible API URL, default
|
||||||
`https://api.kilo.ai/api/openrouter`; falls back to `BANTAM_ENDPOINT`).
|
`https://api.kilo.ai/api/openrouter`; falls back to `BANTAM_ENDPOINT`).
|
||||||
@@ -283,8 +280,8 @@ result payloads fed back to the LLM are never colored.
|
|||||||
|
|
||||||
## The agentic loop
|
## The agentic loop
|
||||||
|
|
||||||
1. **Initialization**: read the config file (`.bantam.cfg` if present, else
|
1. **Initialization**: read the config file `.bantam.cfg` from the current
|
||||||
`model.cfg`). Discover the context-window size from the `/models` endpoint
|
working directory. Discover the context-window size from the `/models` endpoint
|
||||||
(or fall back to `context_window`, default `262144` tokens). Prepare the
|
(or fall back to `context_window`, default `262144` tokens). Prepare the
|
||||||
messages array starting with the built-in system prompt.
|
messages array starting with the built-in system prompt.
|
||||||
2. **Input processing**: take the user prompt (command-line file parameter or
|
2. **Input processing**: take the user prompt (command-line file parameter or
|
||||||
|
|||||||
Reference in New Issue
Block a user