You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-13Lines changed: 11 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,9 @@ The protocol makes easier for other editors integrate and having a server in the
49
49
50
50
With the LLMs models race, the differences between them tend to be irrelevant in the future, but UX on how to edit code or plan changes is something that will exist, ECA helps editors focus on that.
51
51
52
-
## Getting started
52
+
**How it works**: Editors spawn the server via `eca server` and communicate via stdin/stdout, similar to LSPs. Supported editors already download latest server on start and require no extra configuration.
53
+
54
+
## Quickstart
53
55
54
56
### 1. Install the editor plugin
55
57
@@ -62,19 +64,19 @@ Install the plugin for your editor and ECA server will be downloaded and started
62
64
63
65
### 2. Set up your first model
64
66
65
-
To use ECA, you need to configure at least one model with your API key. See the [Models documentation](https://eca.dev/models#adding-and-configuring-models) for detailed instructions on:
67
+
To use ECA, you need to configure at least one model with your API key (_tip: Github Copilot offer free models!_). See the [Models documentation](https://eca.dev/models#adding-and-configuring-models) for detailed instructions on:
66
68
67
-
- Setting up API keys for OpenAI, Anthropic, or Ollama
69
+
- Setting up API keys for OpenAI, Anthropic, Copilot or Ollama
68
70
- Adding and customizing models
69
71
- Configuring custom providers
70
72
71
-
**Quick start**: Create a `.eca/config.json` file in your project root with your API key:
73
+
**Quick start**: Create a `~/.config/eca/config.json` file with your API key:
@@ -85,11 +87,7 @@ To use ECA, you need to configure at least one model with your API key. See the
85
87
86
88
Once your model is configured, you can start using ECA's chat interface in your editor to ask questions, review code, and work together on your project.
87
89
88
-
Type `/init` to ask ECA to create a [AGENTS.md](http://agents.md) file which will help ECA on next iterations have good context about your project standards.
89
-
90
-
## How it works
91
-
92
-
Editors spawn the server via `eca server` and communicate via stdin/stdout, similar to LSPs. Supported editors already download latest server on start and require no extra configuration.
90
+
Type `/init` to ask ECA to create/update a [AGENTS.md](http://agents.md) file which will help ECA on next iterations have good context about your project standards.
93
91
94
92
## Roadmap
95
93
@@ -98,7 +96,7 @@ Check the planned work [here](https://github.com/orgs/editor-code-assistant/proj
98
96
## Contributing
99
97
100
98
Contributions are very welcome, please open an issue for discussion or a pull request.
101
-
For developer details, check [this doc](https://eca.dev/development).
99
+
For developer details, check [development docs](https://eca.dev/development).
0 commit comments