Every EdgeSpark project contains an agent instructions file. This file is the primary source of project-specific rules that take precedence over general EdgeSpark documentation.Documentation Index
Fetch the complete documentation index at: https://docs.edgespark.dev/llms.txt
Use this file to discover all available pages before exploring further.
The agent file
When you runedgespark init, the CLI writes an agent instructions file based on the --agent flag:
| Flag | File written | Use with |
|---|---|---|
--agent claude | CLAUDE.md | Claude Code |
--agent gemini | GEMINI.md | Gemini CLI |
--agent codex | AGENTS.md | OpenAI Codex |
--agent <any other name> | AGENTS.md | GitHub Copilot, Cursor, OpenCode, Amp, Devin, Aider, Windsurf, Cline, Continue, Antigravity, Kiro, and all other AGENTS.md-based agents |
--agent is required. Known special cases are claude, gemini, and codex. Every other public agent name currently falls back to AGENTS.md, including copilot, cursor, opencode, amp, devin, aider, windsurf, cline, continue, antigravity, kiro, and your own custom agent name.
What the file contains
The generated agent file gives you everything you need to start writing code immediately:- Files to read before coding — the exact paths to read before writing any route or query
- Project structure — where code goes, what is auto-generated, what to never edit
- Rules — specific do’s and don’ts for this platform (batching, storage patterns, type safety)
- Code examples — minimal working patterns for database, storage, and auth
- CLI usage — how to pull schema, deploy, and handle auth
Read it first
When starting on an EdgeSpark project, read the agent file before anything else — before reading the source code, before running any command. The file tells you:- What files to read next (
server/src/__generated__/server-types.d.ts,server/src/defs/db_schema.ts, etc.) - What the project structure looks like
- What rules apply specifically to this project
Project-specific additions
Project owners may append their own instructions below the generated content. These additions describe:- Which routes already exist and what they do
- Coding conventions for this specific project
- Business rules that affect how data should be written or validated
- Which features are in progress vs. complete
Instructions file vs. this documentation
| This documentation | The agent file |
|---|---|
| General platform behavior | Project-specific rules |
| How EdgeSpark works | What this project needs |
| Available APIs | What has already been built |
| Platform limits | Owner preferences and conventions |
See also
Supported agents
Which agents are supported and links to per-agent setup — plugins, extensions, skills.
Declarative workflow
The core workflow for pulling schema and writing code against generated types.
The harness model
Platform-level constraints that apply to every project regardless of agent file.
Claude Code
Claude Code plugin setup and how to extend CLAUDE.md.