docs(cli): customization (settings, themes, statusline, rules, skills, MCP) - #401
Conversation
Cover the local TOML settings file (per-platform locations, hot reload, error fallback, local-only/no cloud sync), editing settings by asking the agent, /theme with terminal background detection, and the statusline with /statusline customization. Drop the keybindings section: custom keybinding overrides are not loaded by the CLI yet. Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
There was a problem hiding this comment.
Overview
This PR expands src/content/docs/cli/configuration.mdx from a placeholder into a full CLI configuration page covering the TOML settings file, agent-assisted edits, themes, statusline customization, and related pages.
Concerns
- The page over-promises settings-file hot reload for theme changes made by editing the file or by asking the agent to edit the file; the current TUI applies rendered themes through
/themeand startup, not generic settings-file reload. - The Windows settings path currently renders with doubled backslash separators.
Verdict
Found: 0 critical, 2 important, 1 suggestions
Request changes
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
{{WARP_CLI}} tokens are not substituted in MDX frontmatter by the build
pipeline, so the built title/description showed the raw token. Body prose
keeps {VARS.WARP_CLI}.
Co-Authored-By: Oz <oz-agent@warp.dev>
Consolidate the CLI docs: fold the context page's rules, skills, bundled skills, and MCP sections into configuration.mdx, retitled "Customizing the Warp CLI". Dedupe the modify-settings bundled skill treatment and switch cross-links to in-page anchors. The context.mdx file itself is removed at integration. Co-Authored-By: Oz <oz-agent@warp.dev>
…cli-cli-configuration
…tter Follows the site-wide WARP_CLI var update on the base branch; body prose picks up the new name via the var automatically. Co-Authored-By: Oz <oz-agent@warp.dev>
Address review on PR #401: settings values hot-reload from disk, but the rendered theme only re-applies via /theme or at the next startup, so the settings-file and agent-edit sections no longer promise immediate effect for theme changes. Also scope the Themes section's immediate-apply claim to /theme. Windows path verified to render with single backslashes in source and built HTML; no change needed. Co-Authored-By: Oz <oz-agent@warp.dev>
Editorial polish pass: after the intro's first mention, refer to the product as "the CLI" instead of repeating the full name in every section. The full name stays in the frontmatter, the intro, and the reference link. No structural, factual, heading, or link-target changes. Co-Authored-By: Oz <oz-agent@warp.dev>
Per editorial direction: collapse the skills-menu step list into the non-obvious behaviors (selection inserts /skill-name for editing, argument passing, direct invocation) and drop the arrow-select narration in the /mcp view. Keep the statusline config steps since its keys are surprising (Esc saves, arrows reorder). No headings, facts, or link targets changed. Co-Authored-By: Oz <oz-agent@warp.dev>
…rose Apply orchestrator audit: keep only statusline items with non-obvious behavior as bullets and fold the self-explanatory ones into one sentence, shorten the working-directory context paragraph, and replace the four per-state /mcp bullets with two lines. Co-Authored-By: Oz <oz-agent@warp.dev>
|
Reviewed as part of a coherence pass across the Orphaned stub (the #423 pattern):
Gap (worth fixing here):
Accuracy nit:
Cosmetic: sidebar label is still "Configuration" while the page is now "Customizing the Warp Agent CLI" — presumably resolved by the planned |
…cli-cli-configuration
Master's statusline catalog changed (moira's #14257/#14458): the auto-queue item was removed, and Vim mode indicator and GitHub pull request items were added. Auto-approve and Vim mode indicator are now on by default. Update the item list, defaults, and the auto-approve and git diff descriptions accordingly. Themes, settings paths, and the /statusline config flow re-verified against master and unchanged. Co-Authored-By: Oz <oz-agent@warp.dev>
- Remove orphaned context stub (content lives in configuration.mdx via #401) and its sidebar entry; repoint the reference page link - Fix stale auto-approve statusline claim in permissions page (the indicator is default-on since the statusline catalog update) Co-Authored-By: Oz <oz-agent@warp.dev>
Drafts the Warp Agent CLI customization page for the CLI launch docs. As part of the 13→9 page consolidation, this page now also absorbs the content of the agent context page from PR #400 (that PR will be closed;
context.mdxitself is deleted at integration, and the slug rename tocustomizationhappens at integration).Pages changed
src/content/docs/cli/configuration.mdx— retitled "Customizing the Warp Agent CLI"; covers CLI configuration plus agent context (rules, skills, MCP)Features covered
~/.warp_cli/settings.toml; Linux~/.config/warp-terminal/cli/settings.toml, XDG-aware; Windows%LOCALAPPDATA%\warp\Warp\config\cli\settings.toml), example TOML, hot reload while running, invalid-value fallback to defaults, and the local-only story (never cloud-synced; fully separate from the Warp app's settings file)./theme auto|light|dark, immediate apply + persistence asappearance.theme, terminal background detection at startup (light → light; dark/undetectable → dark)./statuslineconfig flow (Enter toggle, arrow-key reorder, Esc save, Ctrl+C cancel).cdre-scopes rules and skills;AGENTS.md/WARP.mdproject rules; global~/.agents/AGENTS.mdrules; cross-links agent-platform/capabilities/rules./skillsmenu (search, select, insert/skill-namefor extra instructions), direct/skill-nameinvocation with arguments; cross-links agent-platform/capabilities/skills./modify-settings(canonical treatment lives in "Edit settings with the agent") and/tui-migrate-setup(migrate compatible settings + global MCP definitions from the Warp app; no credentials copied)./mcpmanagement view (transport, status, tool counts; start/stop/retry; OAuth reopen + log out), CLI-specific global.mcp.jsonconfig (samemcpServersformat, auto-reloaded, servers auto-start after login); cross-links agent-platform/capabilities/mcp.Dropped/unconfirmed
keybindings.yamlis not wired in the CLI process (the loader only runs in the app's launch path); code comments mark override loading as a follow-up./theme(documented that way).Validation
npm run buildpasses (363 pages); built title renders as "Customizing the Warp Agent CLI | Warp".Suggested reviewer(s): Kevin, moira
Co-Authored-By: Oz oz-agent@warp.dev