Skip to content

Commit 1ef4275

Browse files
committed
docs
1 parent 03c0a4c commit 1ef4275

File tree

3 files changed

+13
-55
lines changed

3 files changed

+13
-55
lines changed

docs/configuration.md

Lines changed: 4 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ Via env var during server process spawn:
4141
ECA_CONFIG='{"myConfig": "my_value"}' eca server
4242
```
4343

44+
## Models
45+
46+
For models configuration check the [dedicated models section](./models.md#adding-and-configuring-models).
47+
4448
## Rules
4549

4650
Rules are contexts that are passed to the LLM during a prompt and are useful to tune prompts or LLM behavior.
@@ -103,27 +107,6 @@ For MCP servers configuration, use the `mcpServers` config, example:
103107
}
104108
```
105109

106-
## Custom LLM providers
107-
108-
It's possible to configure ECA to be aware of custom LLM providers if they follow a API schema similar to currently supported ones (openai, anthropic), example for a custom hosted litellm server:
109-
110-
```javascript
111-
{
112-
"customProviders": {
113-
"my-company": {
114-
"api": "openai",
115-
"urlEnv": "MY_COMPANY_API_URL", // or "url": "https://litellm.my-company.com",
116-
// "completionUrlRelativePath": "/v1/responses", // only if default is not enough,
117-
"keyEnv": "MY_COMPANY_API_KEY", // or "key": "123",
118-
"models": ["gpt-5", "deepseek-r1"],
119-
"defaultModel": "deepseek-r1"
120-
}
121-
}
122-
}
123-
```
124-
125-
With that, ECA will include in the known models something like: `my-company/gpt-4.1`, `my-company/deepseek-r1`.
126-
127110
## Custom command prompts
128111

129112
You can configure custom command prompts for project, global or via `commands` config pointing to the path of the commands.
@@ -157,37 +140,6 @@ Just add to your config the `commands` pointing to `.md` files that will be sear
157140
}
158141
```
159142

160-
## Adding models
161-
162-
It's possible to add new models just adding `models <yourmodel>`, example:
163-
164-
```javascript
165-
{
166-
"models": {
167-
"o1": {}
168-
}
169-
}
170-
```
171-
172-
### Overriding model payloads
173-
174-
To override the payload sent to LLMs via `models <modelName> extraPayload` config, this way you can configure custom LLM settings like `temperature`, `reasoning_effort`, `verbosity` etc.
175-
This config will be merged with current default used by ECA.
176-
177-
Example:
178-
179-
```javascript
180-
{
181-
"models": {
182-
"gpt-5": {
183-
"extraPayload": {
184-
"verbosity": "high"
185-
}
186-
}
187-
}
188-
}
189-
```
190-
191143
## All configs
192144

193145
### Schema

docs/models.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ You can customize model parameters like temperature, reasoning effort, etc.:
9292
}
9393
```
9494

95+
This config will be merged with current default used by ECA.
96+
9597
## Custom model providers
9698

9799
ECA allows you to configure custom LLM providers that follow API schemas similar to OpenAI or Anthropic. This is useful when you want to use:
@@ -102,15 +104,18 @@ ECA allows you to configure custom LLM providers that follow API schemas similar
102104

103105
### Setting up a custom provider
104106

105-
Add a `customProviders` section to your `.eca/config.json` file:
107+
It's possible to configure ECA to be aware of custom LLM providers if they follow a API schema similar to currently supported ones (openai, anthropic), example for a custom hosted litellm server:
108+
109+
Example:
106110

111+
`~/.config/eca/config.json`
107112
```json
108113
{
109114
"customProviders": {
110115
"my-company": {
111116
"api": "openai",
112-
"urlEnv": "MY_COMPANY_API_URL",
113-
"keyEnv": "MY_COMPANY_API_KEY",
117+
"urlEnv": "MY_COMPANY_API_URL", // or "url"
118+
"keyEnv": "MY_COMPANY_API_KEY", // or "key"
114119
"models": ["gpt-5", "deepseek-r1"],
115120
"defaultModel": "deepseek-r1"
116121
}

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ nav:
1414
- Protocol: protocol.md
1515
- Features: features.md
1616
- Installation: installation.md
17+
- Models: models.md
1718
- Support Us: https://github.com/sponsors/ericdallo
1819
- Changelog: CHANGELOG.md
1920

0 commit comments

Comments
 (0)