Skip to content

Commit 64c7e58

Browse files
committed
docs
1 parent d370ce1 commit 64c7e58

File tree

6 files changed

+91
-76
lines changed

6 files changed

+91
-76
lines changed

README.md

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ _Demo using [eca-vscode](https://github.com/editor-code-assistant/eca-vscode)_
1515

1616
<hr>
1717
<p align="center">
18-
<a href="#installation"><strong>installation</strong></a> •
18+
<a href="./docs/installation.md"><strong>installation</strong></a> •
19+
<a href="./docs/features.md"><strong>features</strong></a> •
1920
<a href="./docs/configuration.md"><strong>configuration</strong></a> •
20-
<a href="./docs/capabilities.md"><strong>capabilities</strong></a> •
21+
<a href="./docs/models.md"><strong>models</strong></a> •
2122
<a href="./docs/protocol.md"><strong>protocol</strong></a>
2223
</p>
2324
<hr>
@@ -37,22 +38,6 @@ A Free and OpenSource editor-agnostic tool that aims to easily link LLMs <-> Edi
3738

3839
The protocol makes easier for other editors integrate and having a server in the middle helps adding more features quickly like exporting metrics of features usage or single way to configure it for any editor.
3940

40-
## Installation
41-
42-
Eca is written in Clojure and compiled into a native binary via graalvm. You can download the [native binaries from Github Releases](https://github.com/editor-code-assistant/eca/releases) or use the install script for convenience:
43-
44-
Stable release:
45-
46-
```bash
47-
bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install)
48-
```
49-
50-
nightly build:
51-
52-
```bash
53-
bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install) --version nightly --dir ~/
54-
```
55-
5641
## Usage
5742

5843
Editors should spawn the server via `eca server` and communicate via stdin/stdout. Logs are printed to stderr, use `--verbose` to log client<->server communication or `--log-level debug` to log more info like LLM responses.

docs/capabilities.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

docs/features.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Features
2+
3+
## Chat
4+
5+
Chat is the main feature of ECA, allowing LLM to behave like a chat, answering questions, or agent, making changes using tools.
6+
7+
### Tools
8+
9+
ECA leverage tools to give more power to the LLM, this is the best way to make LLMs have more context about your codebase and behave like an agent.
10+
It supports both MCP server tools + ECA native tools, for more details, check [configuration]().
11+
12+
### Native tools
13+
14+
ECA support built-in tools to avoid user extra installation and configuration, these tools are always included on models requests that support tools and can be [disabled/configured via config](./configuration.md) `nativeTools`.
15+
16+
Some native tools like `filesystem` have MCP alternatives, but ECA having them built-in avoid the need to external dependencies like npx.
17+
18+
#### Filesystem
19+
20+
Provides access to filesystem under workspace root, listing and reading files and directories a subset of [official MCP filesystem](https://mcpserverhub.com/servers/filesystem), important for agentic operations, without the need to support NPM or other tools.
21+
22+
- `eca_read_file`: read a file content.
23+
- `eca_write_file`: write content to file.
24+
- `eca_move_file`: move/rename a file.
25+
- `eca_list_directory`: list a directory.
26+
- `eca_search_files`: search in a path for files matching a pattern.
27+
- `eca_grep`: ripgrep/grep for paths with specified content.
28+
- `eca_replace_in_file`: replace a text with another one in file.
29+
30+
#### Shell
31+
32+
Provides access to run shell commands, useful to run build tools, tests, and other common commands, supports exclude/include commands.
33+
34+
- `eca_shell_command`: run shell command. Supports configs to exclude commands via `:nativeTools :shell :excludeCommands`.
35+
36+
## Completion
37+
38+
Soon
39+
40+
## Edit
41+
42+
Soon
43+

docs/installation.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Installation
2+
3+
Eca is written in Clojure and compiled into a native binary via graalvm. You can download the [native binaries from Github Releases](https://github.com/editor-code-assistant/eca/releases) or use the install script for convenience:
4+
5+
Stable release:
6+
7+
```bash
8+
bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install)
9+
```
10+
11+
nightly build:
12+
13+
```bash
14+
bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install) --version nightly --dir ~/
15+
```

docs/models.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Models
2+
3+
## Built-in providers and capabilities
4+
5+
| model | MCP / tools | thinking/reasioning | prompt caching | web_search |
6+
|-----------|-------------|---------------------|----------------|------------|
7+
| OpenAI || X | X ||
8+
| Anthropic || X |||
9+
| Ollama || X | X | X |
10+
11+
### OpenAI
12+
13+
- [o4-mini](https://platform.openai.com/docs/models/o4-mini)
14+
- [o3](https://platform.openai.com/docs/models/o3)
15+
- [gpt-4.1](https://platform.openai.com/docs/models/gpt-4.1)
16+
17+
### Anthropic
18+
19+
- [claude-sonnet-4-0](https://docs.anthropic.com/en/docs/about-claude/models/overview)
20+
- [claude-opus-4-0](https://docs.anthropic.com/en/docs/about-claude/models/overview)
21+
- [claude-3-5-haiku-latest](https://docs.anthropic.com/en/docs/about-claude/models/overview)
22+
23+
### Ollama
24+
25+
- [any local ollama model](https://ollama.com/search)
26+
27+
## Custom providers
28+
29+
ECA support configure extra LLM providers via `customProviders` config, for more details check [configuration](./configuration.md#custom-llm-providers).

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav:
1010
- Overview: README.md
1111
- Configuration: configuration.md
1212
- Development: development.md
13-
- Capabilities: capabilities.md
13+
- Models: models.md
1414
- Protocol: protocol.md
1515
- Features: features.md
1616
- Installation: installation.md

0 commit comments

Comments
 (0)