Skip to content

Commit 6cb71c2

Browse files
committed
Update docs: directory paths in config
1 parent 09d2c2d commit 6cb71c2

4 files changed

Lines changed: 27 additions & 4 deletions

File tree

docs/config/commands.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,17 @@ You can configure in multiple different ways:
3737

3838
=== "Config"
3939

40-
Just add to your config the `commands` pointing to `.md` files that will be searched from the workspace root if not an absolute path:
40+
Add to your config the `commands` key. `path` can point to a single `.md` file or a directory. Directories load markdown files recursively. Relative paths are searched from each workspace root if not an absolute path:
4141

4242
```javascript title="~/.config/eca/config.json"
4343
{
4444
"commands": [{"path": "my-custom-prompt.md"}]
4545
}
4646
```
4747

48-
ECA will make available a `/my-custom-prompt` command after creating that file.
48+
```javascript title="~/.config/eca/config.json"
49+
// Load all command files from a directory recursively
50+
{
51+
"commands": [{"path": "/home/user/commands"}]
52+
}
53+
```

docs/config/introduction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ By default ECA consider the following as the base configuration:
9494
"hooks": {},
9595
"rules" : [],
9696
"commands" : [],
97+
"skills": [],
9798
"disabledTools": [],
9899
"toolCall": {
99100
"approval": {

docs/config/rules.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,21 @@ ECA loads rules from 3 sources:
3535

3636
=== "Config"
3737

38-
Paths listed in the `rules` config key. Relative paths are searched from each workspace root. Absolute paths inside a workspace behave as project rules; absolute paths outside workspaces behave as global rules.
38+
Paths listed in the `rules` config key. `path` can point to a single rule file or a directory. Directories are loaded recursively, loading all files within. Relative paths are searched from each workspace root. Absolute paths inside a workspace behave as project rules; absolute paths outside workspaces behave as global rules.
3939

4040
```javascript title="~/.config/eca/config.json"
4141
{
4242
"rules": [{"path": "my-rule.md"}]
4343
}
4444
```
4545

46+
```javascript title="~/.config/eca/config.json"
47+
// Load all rules from a directory recursively
48+
{
49+
"rules": [{"path": "/home/user/rules"}]
50+
}
51+
```
52+
4653
## Static and path-scoped rules
4754

4855
Most rules should be **static rules**: rules without `paths`. Their full content is automatically included in the system prompt. Use them for guidance that should always be available, such as coding style, response tone, or repository-wide conventions.

docs/config/skills.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: "Configure ECA skills: structured knowledge units that teach the LL
77
![](../images/features/skills.png)
88

99
Skills are folders with `SKILL.md` which teachs LLM how to solve a specific task or gain knowledge about it.
10-
Following the [agentskills](https://agentskills.io/) standard, ECA search for skills following `~/.config/eca/skills/some-skill/SKILL.md` and `.eca/skills/some-skill/SKILL.md` which should contain `name` and `description` metadatas.
10+
Following the [agentskills](https://agentskills.io/) standard, ECA searches for skills following `~/.config/eca/skills/some-skill/SKILL.md`, `.eca/skills/some-skill/SKILL.md`, and `.agents/skills/some-skill/SKILL.md` which should contain `name` and `description` metadatas.
1111

1212
When sending a prompt request to LLM, ECA will send only name and description of all available skills, LLM then can choose to load a skill via `eca__skill` tool if that matches user request.
1313

@@ -75,6 +75,16 @@ Check the examples:
7575
}
7676
```
7777

78+
=== "Config"
79+
80+
Add to your config the `skills` key. `path` can point to a single skill directory (containing `SKILL.md`) or a directory containing multiple skill subdirectories. Directories load `SKILL.md` files recursively. Relative paths are searched from each workspace root if not an absolute path:
81+
82+
```javascript title="~/.config/eca/config.json"
83+
{
84+
"skills": [{"path": "/home/user/skills"}]
85+
}
86+
```
87+
7888
## Parameterized skills
7989

8090
Skills can receive arguments when invoked as slash commands, using the same variable substitution as [custom commands](./commands.md): `$ARGS`, `$ARGUMENTS`, and positional `$1`, `$2`, etc.

0 commit comments

Comments
 (0)