Documentation
Goatfied docs
Everything you need to ship faster with an AI-native editor. Pick a topic below, or jump straight to the Quickstart.
Get started
Introduction
What Goatfied is, how it fits in your workflow, and how it differs from other AI editors.
Quickstart
From install to your first AI edit in five minutes.
Concepts
The mental model: Tab, Composer, Chat, Agent, context, and checkpoints — and how they fit together.
Migrate from VS Code
Bring your editor settings and colour themes across, and see what stays behind.
Migrate from Cursor
Import an existing Cursor setup, with a straight account of what does not transfer.
Desktop app
Native editor for macOS, Windows, and Linux — terminal, source control, and offline editing.
Goatfied for Web
Open Goatfied in your browser — no install required.
Agent
Overview
How the agent works: instructions and rules, the tool loop, and the model that drives it.
Modes
Build, Plan, Debug, Multitask, and Ask — plus your own custom modes.
Tools
The tools the agent can call: read, write, edit, list, grep, run terminal, and fetch the web.
Planning
Have the agent draft a step-by-step plan you can review and edit before any code changes.
Subagents
Fan a goal out across parallel agents, each isolated on its own worktree branch.
Reviewing changes
Accept or reject every edit as a diff, and snapshot before a big change.
Queued messages
Keep typing while the agent works — follow-ups thread into the same session.
Composer
Ask for a change in plain English, get a multi-file diff you can review and apply.
Chat
Side-pane chat scoped to your repo, with @-mentions for files, symbols, docs and the web.
Terminal
Run commands inline, and ask the agent to explain or fix what just failed.
Checkpoints
Snapshot your workspace before a large change, and put it back if you need to.
Cloud agents
Hand a task to a cloud sandbox that pushes a branch, opens a PR, and reports back screenshots and logs.
Background agents
Runs that clone, build, test, and open PRs without holding the keyboard.
Tab
Context
@-mentions
@file, @folder, @symbol, @codebase, @docs, @web, @git — pull exactly the context you need.
Rules
Project, user, and team rules that steer every AI request.
Memories
Persistent project notes the assistant recalls across sessions.
Codebase indexing
How Goatfied builds and refreshes the embedding index for your repo.
Ignore files
What the index leaves out, and what @-mentions will still attach.
Docs in your repo
Pull the documentation you already have into a conversation.
MCP servers
Wire Model Context Protocol servers into chat and the agent.
Models
Models & pricing
The full model table, context windows, and how routing and fallbacks work.
Goat Frontier
Our flagship reasoning class. Default for Composer, Chat, and Agents.
Goat Fast
Low-latency responses for tight feedback loops.
GOAT-2
Our next-gen Composer-class model for autonomous agent runs.
Third-party models
Claude, GPT, Gemini, Grok, Llama and more — served directly, included in your plan. BYOK optional.
Custom endpoints
Point Goatfied at your self-hosted vLLM, Ollama, or any OpenAI-compatible URL.
CLI & API
CLI
Run the editor's models from a terminal or CI — print mode, interactive REPL, and resumable sessions.
Installation
Install the goatfied binary with npm or npx. Node 18+.
Authentication
Save a gf_ token or use GOATFIED_TOKEN in CI.
Sessions
Resume conversations with --resume and --continue.
Automation
Print mode, JSON output, and CI pipelines.
Cloud agents (CLI)
Launch and manage cloud agents from the terminal.
Configuration
Persist defaults like the model and API URL.
API
The HTTP API behind the editor — chat, edit, agent, and indexing.
Integrations
GitHub
Sign in once to clone, push, publish, and open PRs — and trigger agents from issues and PRs.
Slack
Mention @goatfied in Slack to launch a cloud agent on a repo.
Linear
Trigger an agent from a Linear issue with @goatfied.
Source control
Stage, commit, branch, publish, and sync without leaving the editor.
MCP servers
Connect Linear, Slack, and any MCP-compatible tool.
Guides
Account
Teams & Enterprise
Admin platform
platform.goatfied.com — members, usage, billing, SSO, audit, and policy in one console.
Teams plan
Shared rules, one invoice, usage you can see per seat.
SSO
SAML 2.0 with Okta, Entra ID, Google Workspace and others.
Self-hosted inference
Run inference on infrastructure you control.
Audit log
An append-only record of admin and security events.
Trust & policy
Can't find what you need?
Email docs@goatfied.com and we'll usually answer same-day.