8000 docs(base): add vanilla single-project CLAUDE.md/AGENTS.md example by simon-inkie · Pull Request #11 · simon-inkie/inkie-deck · GitHub
[go: up one dir, main page]

Skip to content
8000
Merged
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions packages/base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,25 @@ machinery that speaks the message protocol, use `bin/inbox`, or the application
in `packages/deck`, or implement `docs/protocol.md` in your language of choice
and check it against `conformance/corpus.json`.

### Not sure you need this package at all?

Everything above is for a persistent, named agent (or a team of them) with its
own identity files under an `AGENTS_HOME`, carried across sessions rather than
reset each time. If that's not what you're doing, you don't need this
package, and this section is here so you know that rather than reaching for
`create-agent.sh` out of habit. A vanilla Claude Code or Codex session already
gives you project context with zero setup: drop a `CLAUDE.md` (Claude Code) or
`AGENTS.md` (Codex) straight in your project root, the directory the CLI is
launched from. Both tools also walk upward from there through parent
directories picking up more of the same file, and both have a separate
user-level file that applies across every project regardless of which repo
you're in: `~/.claude/CLAUDE.md` for Claude Code, `~/.codex/AGENTS.md` (or
`$CODEX_HOME/AGENTS.md` if set) for Codex. Project-level and user-level files
are concatenated together, not one overriding the other. None of that is
this package, it's native to the tools; it's documented here only because the
question "do I need the agent-home pattern for this" comes up before anyone
knows the answer is already built in.

## Development

This package is markdown, shell and python3, so it has no build and no
Expand Down
Loading
0