Skip to content

Commit 3305465

Browse files
committed
Follow https://agents.md standard
1 parent 32498e1 commit 3305465

File tree

10 files changed

+14
-12
lines changed

10 files changed

+14
-12
lines changed
File renamed without changes.

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Unreleased
44

5+
- Consider `AGENTS.md` instead of `AGENT.md`, following the https://agents.md standard.
6+
57
## 0.32.2
68

79
- Fix option to set default chat behavior from config via `chat defaultBehavior`. #71

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ To use ECA, you need to configure at least one model with your API key. See the
8383

8484
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.
8585

86-
Type `/init` to ask ECA to create a AGENT.md file which will help ECA on next iterations have good context about your project standards.
86+
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.
8787

8888
## How it works
8989

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ There are 3 possible ways to configure rules following this order of priority:
236236
"defaultBehavior": "agent"
237237
"welcomeMessage" : "Welcome to ECA!\n\nType '/' for commands\n\n"
238238
},
239-
"agentFileRelativePath": "AGENT.md"
239+
"agentFileRelativePath": "AGENTS.md"
240240
"index" : {
241241
"ignoreFiles" : [ {
242242
"type" : "gitignore"

docs/features.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ Here are the current supported contexts types:
6464
- `repoMap`: a summary view of workspaces files and folders, server will calculate this and pass to LLM. Currently, the repo-map includes only the file paths in git.
6565
- `mcpResource`: resources provided by running MCPs servers.
6666

67-
#### AGENT.md automatic context
67+
#### AGENTS.md automatic context
6868

69-
ECA will always include if found the `AGENT.md` file (configurable via `agentFileRelativePath` config) as context, searching for both `/project-root/AGENT.md` and `~/.config/eca/AGENT.md`.
69+
ECA will always include if found the `AGENTS.md` file (configurable via `agentFileRelativePath` config) as context, searching for both `/project-root/AGENT.md` and `~/.config/eca/AGENT.md`.
7070

7171
You can ask ECA to create/update this file via `/init` command.
7272

@@ -78,7 +78,7 @@ Eca supports commands that usually are triggered via shash (`/`) in the chat, co
7878

7979
The built-in commands are:
8080

81-
`/init`: Create/update the AGENT.md file with details about the workspace for best LLM output quality.
81+
`/init`: Create/update the AGENTS.md file with details about the workspace for best LLM output quality.
8282
`/login`: Log into a provider. Ex: `/login github-copilot`
8383
`/costs`: Show costs about current session.
8484
`/resume`: Resume a chat from previous session of this workspace folder.

resources/prompts/init.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Analyze this codebase and create an AGENT.md file containing:
1+
Analyze this codebase and create an AGENTS.md file containing:
22
1. Build/lint/test commands - especially for running a single test
33
2. Code style guidelines including imports, formatting, types, naming conventions, error handling, etc.
44

55
The file you create will be given to agentic coding agents (such as yourself) that operate in this repository. Make it about 20 lines long.
66

7-
If there's already an AGENT.md, improve it if it's located in $workspaceRoots.
7+
If there's already an AGENTS.md, improve it if it's located in $workspaceRoots.

src/eca/config.clj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
:mcpServers {}
6060
:chat {:defaultBehavior "agent"
6161
:welcomeMessage "Welcome to ECA!\n\nType '/' for commands\n\n"}
62-
:agentFileRelativePath "AGENT.md"
62+
:agentFileRelativePath "AGENTS.md"
6363
:index {:ignoreFiles [{:type :gitignore}]
6464
:repoMap {:maxTotalEntries 800
6565
:maxEntriesPerDir 50}}})

src/eca/features/commands.clj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
(dissoc :server))))
7676
eca-commands [{:name "init"
7777
:type :native
78-
:description "Create/update the AGENT.md file teaching LLM about the project"
78+
:description "Create/update the AGENTS.md file teaching LLM about the project"
7979
:arguments []}
8080
{:name "login"
8181
:type :native

src/eca/features/context.clj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
(def ^:private logger-tag "[CONTEXT]")
1515

1616
(defn ^:private agents-file-contexts
17-
"Search for AGENT.md file both in workspaceRoot and global config dir."
17+
"Search for AGENTS.md file both in workspaceRoot and global config dir."
1818
[db config]
1919
(let [local-agent-files (keep (fn [{:keys [uri]}]
2020
(let [agent-file (fs/path (shared/uri->filename uri) (:agentFileRelativePath config))]

test/eca/features/index_test.clj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656

5757
(deftest repo-map-truncation-test
5858
(testing "per-directory truncation shows indicator and global truncated line"
59-
(with-redefs [f.index/git-ls-files (constantly ["AGENT.md"
59+
(with-redefs [f.index/git-ls-files (constantly ["AGENTS.md"
6060
"src/a.clj"
6161
"src/b.clj"
6262
"src/c.clj"
@@ -79,7 +79,7 @@
7979
;; A final global truncated line should also be present
8080
(is (string/includes? out "\n... truncated output (")))))
8181
(testing "global truncation appends final truncated line"
82-
(with-redefs [f.index/git-ls-files (constantly ["AGENT.md"
82+
(with-redefs [f.index/git-ls-files (constantly ["AGENTS.md"
8383
"CHANGELOG.md"
8484
"LICENSE"
8585
"src/a.clj"

0 commit comments

Comments
 (0)