Skip to content

docs: clarify XDG config location #6670

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

Open
pwuersch wants to merge 2 commits into
base: dev
Choose a base branch
from
+10 −6
Open

docs: clarify XDG config location #6670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1737b76
docs: clarify XDG config location
pwuersch Jan 2, 2026
ffc511b
docs: link to config locations for XDG support
pwuersch Jan 2, 2026
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
2 changes: 1 addition & 1 deletion packages/opencode/src/cli/cmd/tui/component/tips.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export const TIPS = [
"Use {highlight}@<agent-name>{/highlight} in prompts to invoke specialized subagents.",
"Press {highlight}Ctrl+X Right/Left{/highlight} to cycle through parent and child sessions.",
"Create {highlight}opencode.json{/highlight} in project root for project-specific settings.",
"Place settings in {highlight}~/.config/opencode/opencode.json{/highlight} for global config.",
"Place settings in {highlight}~/.config/opencode/opencode.json{/highlight} for global config (see docs for XDG support).",
"Add {highlight}$schema{/highlight} to your config for autocomplete in your editor.",
"Configure {highlight}model{/highlight} in config to set your default model.",
"Override any keybind in config via the {highlight}keybinds{/highlight} section.",
Expand Down
4 changes: 2 additions & 2 deletions packages/web/src/content/docs/config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ You can enable specific servers in your local config:

### Global

Place your global OpenCode config in `~/.config/opencode/opencode.json`. Use global config for user-wide preferences like themes, providers, or keybinds.
Place your global OpenCode config in `$XDG_CONFIG_HOME/opencode/opencode.json`. Use global config for user-wide preferences like themes, providers, or keybinds. Global config overrides remote organizational defaults.

Global config overrides remote organizational defaults.
If the `XDG_CONFIG_HOME` environment variable is not set, OpenCode uses the default location: `~/.config/opencode/opencode.json`.

---

Expand Down
4 changes: 2 additions & 2 deletions packages/web/src/content/docs/plugins.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ Browse available plugins in the [ecosystem](/docs/ecosystem#plugins).

Plugins are loaded from all sources and all hooks run in sequence. The load order is:

1. Global config (`~/.config/opencode/opencode.json`)
1. Global config (see [config locations](/docs/config#locations))
2. Project config (`opencode.json`)
3. Global plugin directory (`~/.config/opencode/plugin/`)
3. Global plugin directory
4. Project plugin directory (`.opencode/plugin/`)

Duplicate npm packages with the same name and version are loaded once. However, a local plugin and an npm plugin with similar names are both loaded separately.
Expand Down
6 changes: 5 additions & 1 deletion packages/web/src/content/docs/rules.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ The ones we have seen above, where the `AGENTS.md` is placed in the project root

You can also have global rules in a `~/.config/opencode/AGENTS.md` file. This gets applied across all opencode sessions.

:::note
Global files are placed in your OpenCode config directory. [Learn more about config locations](/docs/config#locations).
:::

Since this isn't committed to Git or shared with your team, we recommend using this to specify any personal rules that the LLM should follow.

---
Expand All @@ -73,7 +77,7 @@ Since this isn't committed to Git or shared with your team, we recommend using t
So when opencode starts, it looks for:

1. **Local files** by traversing up from the current directory
2. **Global file** by checking `~/.config/opencode/AGENTS.md`
2. **Global file** by checking your [config directory](/docs/config#locations) for AGENTS.md

If you have both global and project-specific rules, opencode will combine them together.

Expand Down