Skip to content

Commit 9bfefed

Browse files
committed
docs
1 parent 37149b8 commit 9bfefed

File tree

3 files changed

+80
-73
lines changed

3 files changed

+80
-73
lines changed

docs/configuration.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,39 @@ For MCP servers configuration, use the `mcpServers` config, example:
6868
}
6969
```
7070

71+
## Custom command prompts
72+
73+
You can configure custom command prompts for project, global or via `commands` config pointing to the path of the commands.
74+
Prompts can use variables like `$ARGS`, `$ARG1`, `ARG2`, to replace in the prompt during command call.
75+
76+
=== "Local custom commands"
77+
78+
A `.eca/commands` folder from the workspace root containing `.md` files with the custom prompt.
79+
80+
`.eca/commands/check-performance.md`
81+
```markdown
82+
Check for performance issues in $ARG1 and optimize if needed.
83+
```
84+
85+
=== "Global custom commands"
86+
87+
A `$XDG_CONFIG_HOME/eca/commands` or `~/.config/eca/commands` folder containing `.md` files with the custom command prompt.
88+
89+
`~/.config/eca/commands/check-performance.mdc`
90+
```markdown
91+
Check for performance issues in $ARG1 and optimize if needed.
92+
```
93+
94+
=== "Config"
95+
96+
Just add to your config the `commands` pointing to `.md` files that will be searched from the workspace root if not an absolute path:
97+
98+
```javascript
99+
{
100+
"commands": [{"path": "my-custom-prompt.md"}]
101+
}
102+
```
103+
71104
## Rules
72105

73106
Rules are contexts that are passed to the LLM during a prompt and are useful to tune prompts or LLM behavior.
@@ -114,39 +147,6 @@ There are 3 possible ways to configure rules following this order of priority:
114147
}
115148
```
116149

117-
## Custom command prompts
118-
119-
You can configure custom command prompts for project, global or via `commands` config pointing to the path of the commands.
120-
Prompts can use variables like `$ARGS`, `$ARG1`, `ARG2`, to replace in the prompt during command call.
121-
122-
=== "Local custom commands"
123-
124-
A `.eca/commands` folder from the workspace root containing `.md` files with the custom prompt.
125-
126-
`.eca/commands/check-performance.md`
127-
```markdown
128-
Check for performance issues in $ARG1 and optimize if needed.
129-
```
130-
131-
=== "Global custom commands"
132-
133-
A `$XDG_CONFIG_HOME/eca/commands` or `~/.config/eca/commands` folder containing `.md` files with the custom command prompt.
134-
135-
`~/.config/eca/commands/check-performance.mdc`
136-
```markdown
137-
Check for performance issues in $ARG1 and optimize if needed.
138-
```
139-
140-
=== "Config"
141-
142-
Just add to your config the `commands` pointing to `.md` files that will be searched from the workspace root if not an absolute path:
143-
144-
```javascript
145-
{
146-
"commands": [{"path": "my-custom-prompt.md"}]
147-
}
148-
```
149-
150150
## All configs
151151

152152
=== "Schema"

docs/installation.md

Lines changed: 45 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,47 @@
11
# Installation
22

3-
:warning: ECA is already automatically downloaded in all editor plugins, so you don't need to download it manually, even so, if you want that, follow below:
4-
5-
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 one of the methods below:
6-
7-
## Editor (recommended)
8-
9-
ECA is already downloaded automatically by your ECA editor plugin, so you just need to install the plugin for your editor:
10-
11-
- [Emacs](https://github.com/editor-code-assistant/eca-emacs)
12-
- [VsCode](https://github.com/editor-code-assistant/eca-vscode)
13-
- [Vim](https://github.com/editor-code-assistant/eca-nvim)
14-
- Intellij: Planned, help welcome
15-
16-
## Script (recommended if manual installing)
17-
18-
Stable release:
19-
20-
```bash
21-
bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install)
22-
```
23-
24-
Or if facing issues with command above:
25-
```bash
26-
curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install | sudo bash
27-
```
28-
29-
nightly build:
30-
31-
```bash
32-
bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install) --version nightly --dir ~/
33-
```
34-
35-
## Homebrew (MacOS and Linux)
36-
37-
We have a custom tap using the native compiled binaries for users that use homebrew:
38-
39-
```bash
40-
brew install editor-code-assistant/brew/eca
41-
```
42-
3+
Eca is written in Clojure and compiled into a native binary via graalvm.
4+
5+
!!! info "Warning"
6+
7+
ECA is already automatically downloaded and updated in all editor plugins, so you don't need to handle it manually, even so, if you want that, check the other methods.
8+
9+
=== "Editor (recommended)"
10+
11+
ECA is already downloaded automatically by your ECA editor plugin, so you just need to install the plugin for your editor:
12+
13+
- [Emacs](https://github.com/editor-code-assistant/eca-emacs)
14+
- [VsCode](https://github.com/editor-code-assistant/eca-vscode)
15+
- [Vim](https://github.com/editor-code-assistant/eca-nvim)
16+
- Intellij: Planned, help welcome
17+
18+
=== "Script (recommended if manual installing)"
19+
20+
Stable release:
21+
22+
```bash
23+
bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install)
24+
```
25+
26+
Or if facing issues with command above:
27+
```bash
28+
curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install | sudo bash
29+
```
30+
31+
nightly build:
32+
33+
```bash
34+
bash <(curl -s https://raw.githubusercontent.com/editor-code-assistant/eca/master/install) --version nightly --dir ~/
35+
```
36+
37+
=== "Homebrew"
38+
39+
We have a custom tap using the native compiled binaries for users that use homebrew:
40+
41+
```bash
42+
brew install editor-code-assistant/brew/eca
43+
```
44+
45+
=== "Gtihub releases"
46+
47+
You can download the [native binaries from Github Releases](https://github.com/editor-code-assistant/eca/releases), although it's easy to have outdated ECA using this way.

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ markdown_extensions:
4141
- meta
4242
- toc:
4343
permalink: '#'
44+
- admonition
45+
- pymdownx.details
4446
- pymdownx.emoji:
4547
emoji_index: !!python/name:materialx.emoji.twemoji
4648
emoji_generator: !!python/name:materialx.emoji.to_svg

0 commit comments

Comments
 (0)