agentleFS
usewhaleusewhale/DeepSeek-Code-Whale/AGENTS.md

DeepSeek-Code-Whale

AGENTS.md933 starsChanged 6 months agoMITView on GitHub

Whale is a Go CLI/TUI agent. The entrypoint is cmd/whale. Most application code lives under internal/: Keep new packages focused and place tests next to the code they cover. Prefer Makefile targets on macOS/Linux. On Windows (where make is not available by default), use the equivalent go commands listed above. The .gocache directory is managed automatically so cache paths stay consistent regardless of which method you use. Follow standard Go style: tabs for indentation, gofmt formatting, concise package names, and…

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. usewhale/Whale★ 928100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository4 other files it gives its agents.

The file

We split this AGENTS.md into the rules it gives an agent

4 rules. About 0 are common, 1 is distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep new packages focused and place tests next to the code they cover.

    line 15
  2. Very specific:

    Prefer Makefile targets on macOS/Linux.

    line 26
  3. Very specific:

    Follow standard Go style: tabs for indentation, gofmt formatting, concise package names, and exported identifiers only when cross-package …

    line 30
  4. Very specific:

    Do not commit ~/.whale/ data, ./.whale/settings.json, session logs, or API keys.

    line 42

≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Repository Guidelines

Project Structure & Module Organization

Whale is a Go CLI/TUI agent. The entrypoint is cmd/whale. Most application code lives under internal/:

  • internal/ui/cli and internal/tui for Cobra commands and terminal UI
  • internal/agent for the turn loop, approvals, hooks, and tool orchestration
  • internal/tools for built-in tools such as shell, patch, file, and web actions
  • internal/app, internal/session, internal/memory, and internal/store for runtime state and persistence
  • internal/evals for replay and harness-based eval coverage
  • docs/ for user-facing configuration docs
  • scripts/smoke/ for live API smoke checks that require a real DeepSeek key

Keep new packages focused and place tests next to the code they cover.

Build, Test, and Development Commands

  • make build (or go build -o bin/whale . on Windows without Make) builds bin/whale with the repo-local .gocache
  • make run (or go build -o bin/whale . && ./bin/whale) builds and launches the interactive TUI
  • make test (or go test ./...) runs the full offline Go test suite
  • make test-tui (or go test ./internal/tui/...) runs the TUI-focused subset
  • make test-evals (or go test ./internal/evals/...) runs eval and replay tests
  • make clean removes bin/ and .gocache

Prefer Makefile targets on macOS/Linux. On Windows (where make is not available by default), use the equivalent go commands listed above. The .gocache directory is managed automatically so cache paths stay consistent regardless of which method you use.

Coding Style & Naming Conventions

Follow standard Go style: tabs for indentation, gofmt formatting, concise package names, and exported identifiers only when cross-package use is required. Prefer table-driven tests for behavior matrices. Name files by responsibility, such as tool_repair.go, model_test.go, or preferences_test.go.

Testing Guidelines

Tests use Go's testing package. Name tests TestXxx and keep them adjacent to the implementation. Prefer offline tests with temp dirs, fake providers, and deterministic fixtures; live network checks belong in scripts/smoke/. For user-visible CLI/TUI changes, add or update behavior-level tests, not just helper-unit coverage.

Commit & Pull Request Guidelines

Recent history mixes short imperative subjects with scoped prefixes such as feat(tui): ..., agent: ..., and chore: .... Keep commits small and behavior-focused. PRs should state what changed, why it changed, and what you tested; include terminal output or screenshots when CLI/TUI behavior changes. Open an issue before broad command-surface, session-format, or provider-scope changes.

Security & Configuration Tips

Do not commit ~/.whale/ data, ./.whale/settings.json, session logs, or API keys. Treat project hook config as untrusted input because hooks can execute shell commands.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.