Document engine.command field for custom executable paths#16768
Merged
Document engine.command field for custom executable paths#16768
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add optimal engine command field for agentic engines
Document engine.command field for custom executable paths
Feb 19, 2026
pelikhan
approved these changes
Feb 19, 2026
Contributor
|
@copilot use unbloat-docs instructions to make it shorter |
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the existing engine.command configuration field so users can run a custom engine executable/command instead of the default installation flow.
Changes:
- Adds a “Custom Engine Command” section explaining
engine.commandand common use cases. - Updates the extended configuration example to include the
commandfield. - Provides examples for absolute/relative paths, env-var expansion, and PATH-based commands.
Comments suppressed due to low confidence (2)
docs/src/content/docs/reference/engines.md:149
- “Relative path” is described as relative to the “workflow directory”, but the engine command runs with working directory set to
${GITHUB_WORKSPACE}(repo root) both in normal steps and in AWF (--container-workdir). Suggest updating this to “relative to the repository root /${GITHUB_WORKSPACE}” to match runtime behavior.
- **Relative path**: Path relative to the workflow directory (e.g., `./bin/claude-cli`)
- **Command with environment variable**: Use environment variable expansion (e.g., `$HOME/.local/bin/codex`)
docs/src/content/docs/reference/engines.md:176
- Since
engine.commandcauses the engine’s entireGetInstallationStepsto be skipped (including secret-validation, Node/npm setup, and AWF install when sandbox/firewall is enabled), it’d help to add an explicit note here that users must provision those dependencies themselves (or disable sandbox / providesandbox.agent.commandfor AWF) when usingcommand.
When a custom `command` is specified, the workflow assumes the engine is already installed and available at the specified path. Installation steps will be skipped.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Contributor
Author
Done! Reduced the documentation from ~42 lines to ~10 lines (76% reduction) while preserving all essential information. Commit: 2171d64 Changes:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Plan: Document the engine.command field
The
engine.commandfield already exists and works (implemented, tested, and in schema), but it's not documented in the user-facing documentation. This PR adds documentation for this feature.Checklist:
/docs/src/content/docs/reference/engines.mdChanges Made:
Summary:
The
engine.commandfield was already fully implemented and tested in the codebase, but was undocumented. This PR adds concise user-facing documentation to help users understand how to use custom engine executables in their workflows.Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.