Skip to content

readme: Add a paragraph about AGENT.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bep wants to merge 1 commit into from
Closed

readme: Add a paragraph about AGENT.md #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
# vendor/

gitjoin
.claude/
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ If you need version-pinning, use submodules. If you need a convenient umbrella f

```
.
├── AGENTS.md
├── CLAUDE.md
├── go
│ ├── AGENTS.md
│ ├── apps
Expand All @@ -50,8 +52,17 @@ If you need version-pinning, use submodules. If you need a convenient umbrella f
* `gitjoin.txt` — one Git repository path per line (e.g. `github.com/bep/s3deploy`). Lines starting with `#` are comments.
* `firstup.env` — environment variables for that branch (see [firstupdotenv](https://github.com/bep/firstupdotenv)), typically referencing `op://` paths so you can commit this to Git.
* `AGENTS.md` — AI agent guide for that branch.
* `CLAUDE.md` — one-liner `@AGENTS.md` so Claude Code reads `AGENTS.md`.
* Cloned repo content is automatically added to `.gitignore`.

## Agent instructions

An `AGENTS.md` (paired with a one-line `CLAUDE.md` containing `@AGENTS.md`) at any directory applies to that whole subtree automatically. Claude Code walks up from the current directory and concatenates every ancestor `CLAUDE.md` it finds, so an `AGENTS.md` at the workspace root reaches every subdirectory — including inside the cloned repos. No syncing or copying. Each level can add to its ancestors; e.g. `go/AGENTS.md` layers Go-specific rules on top of a workspace-root `AGENTS.md`.

The split — `AGENTS.md` for the content, `CLAUDE.md` as a one-line `@AGENTS.md` import — is the cross-tool convention: Claude Code reads `CLAUDE.md`, while AGENTS.md-aware tools (Codex, Cursor, …) read `AGENTS.md` directly.

See <https://docs.claude.com/en/docs/claude-code/memory> for the underlying mechanics.

## Usage

Running `gitjoin` from the workspace root syncs all repositories defined in `gitjoin.txt` files recursively: clones missing repos, pulls updates for existing ones, and removes repos no longer listed. Note that you can start at any subdirectory with a `gitjoin.txt` to sync just that subtree.
Expand Down
Loading