docs: add Windows (PowerShell host) usage guide#272
Merged
Conversation
All examples elsewhere in the repo are written for a Bash host shell.
Add docs/usage/windows_usage.md translating the README quick-start
and run_mode.md examples to PowerShell syntax (backtick line
continuation, ${PWD}/$HOME path interpolation, mounting the current
directory to a plain Linux path like /workspace instead of mirroring
the Windows path inside the container).
This is a different topic from the existing powershell_usage.md,
which covers using pwsh *inside* the container - both docs now
cross-link to avoid confusing the two. Linked from docs/usage/README.md
and from the README's Getting Started section.
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
1 participant
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.
Summary
docs/usage/windows_usage.mdfor Windows users running commands from a PowerShell host (Windows PowerShell 5.1 or PowerShell 7+), translating the README quick-start andrun_mode.mdexamples to PowerShell syntax:\${PWD}/$HOMEpath interpolation/workspace) instead of mirroring the Windows path inside the container, which is legal but awkward--network hostrequiring Docker Desktop 4.34+ with host networking enabled, plus thehost.docker.internalfallbackpowershell_usage.md, which covers usingpwshinside the container — the two docs now cross-link so readers land on the right one.docs/usage/README.mdand from the main README's Getting Started section (with a note that the existing examples are Bash-only).Test plan