agentleFS
cmderdevcmderdev/cmder/.github/copilot-instructions.md

cmder

Copilot instructions27k starsChanged 7 days agoMITView on GitHub

Cmder is a portable Windows console distribution. Changes commonly span Windows command scripts, PowerShell profiles, Lua prompt configuration, shell scripts, and the native C++ launcher. Preserve portability: do not introduce machine-specific paths, assumptions about installed software, or changes that overwrite user configuration. - vendor/ contains the shipped startup scripts, shell integrations, defaults, and dependency metadata in vendor/sources.json. - config/ and the vendor/user_*.default files define user-customizable configuration. User changes belong in config/user_* or config/profile.d, not in files marked as overwritten during…

  • In this repositoryOne other file it gives its agents.

The file

Show its rules and text

We split this copilot-instructions.md into the rules it gives an agent

15 rules. About 0 are common, 9 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Prefer .cmd for new command scripts.

    line 24
  2. Very specific:

    Keep command, PowerShell, and shell initialization compatible with portable installations and separate user configuration …

    line 26
  3. Very specific:

    When altering startup behavior, consider cmd.exe, PowerShell, Git Bash, Mintty, Windows Terminal, and ConEmu as applicable.

    line 28
  4. Very specific:

    Keep scripts/utils.ps1 UTF-8 with BOM for Windows PowerShell 5.1.

    line 33
  5. Very specific:

    Update scripts/package-profiles.json rather than adding profile-specific branching to build or pack scripts.

    line 36
  6. Distinctive:

    Keep launcher changes compatible with the supported Win32 and x64 Debug and Release configurations, Visual Studio toolset v143, and Windows …

    line 39
  7. Distinctive:

    Run the smallest applicable Windows PowerShell or PowerShell checks:

    line 44
  8. Distinctive:

    If doing an interractive code ask the user about committing files.

    line 74
  9. Distinctive:

    If there are unreleated changes in the same commit, split them into separate commits.

    line 76
  10. Distinctive:

    Create an untracked code_review_findigs.md file to document any issues found during the review.

    line 78
  11. Distinctive:

    Make sure there is an appropriately versioned CHANGELOG entry for any changes that affect the user experience, including new features, …

    line 86
  12. Distinctive:

    Verify that shipped scripts do not overwrite user-owned configuration or assume a fixed installation path, shell, terminal, or external Git …

    line 98
  13. Very specific:

    Treat changes to .gitattributes, scripts, and workflow files as release affecting.

    line 111
  14. Distinctive:

    When fixing issues found during code review, please make sure to address all the comments and suggestions provided by the reviewer.

    line 116
  15. Distinctive:

    If you disagree with any feedback, provide a clear explanation for your decision.

    line 119

≈ “Common” is an estimate: at least 1 in 5 of the 3,827 Copilot instructions files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
copilot-instructions.md

Cmder Repository Instructions

Cmder is a portable Windows console distribution. Changes commonly span Windows command scripts, PowerShell profiles, Lua prompt configuration, shell scripts, and the native C++ launcher. Preserve portability: do not introduce machine-specific paths, assumptions about installed software, or changes that overwrite user configuration.

Repository map

  • vendor/ contains the shipped startup scripts, shell integrations, defaults, and dependency metadata in vendor/sources.json.
  • config/ and the vendor/user_*.default files define user-customizable configuration. User changes belong in config/user_* or config/profile.d, not in files marked as overwritten during updates.
  • scripts/ builds, packages, and updates the distribution. Shared PowerShell helpers live in scripts/utils.ps1; package variants are data-driven by scripts/package-profiles.json.
  • launcher/ is the Visual C++ Cmder launcher (CmderLauncher.vcxproj).
  • .github/workflows/ is the authoritative CI behavior.

Implementation rules

  • Prefer .cmd for new command scripts. The only tracked .bat files are Cmder.bat and the vendor/init.bat compatibility shim.
  • Keep command, PowerShell, and shell initialization compatible with portable installations and separate user configuration (CMDER_USER_CONFIG).
  • When altering startup behavior, consider cmd.exe, PowerShell, Git Bash, Mintty, Windows Terminal, and ConEmu as applicable. Preserve the selected terminal profile and user settings.
  • Reuse helpers in scripts/utils.ps1; use -Verbose output and fail clearly when prerequisites or operations are missing.
  • Keep scripts/utils.ps1 UTF-8 with BOM for Windows PowerShell 5.1. Preserve existing encodings and line endings elsewhere: .cmd, .bat, and .ps1 use CRLF; Markdown and shell scripts use LF.
  • Update scripts/package-profiles.json rather than adding profile-specific branching to build or pack scripts. Keep vendor/sources.json versions and URLs aligned when changing bundled dependencies.
  • Keep launcher changes compatible with the supported Win32 and x64 Debug and Release configurations, Visual Studio toolset v143, and Windows SDK 10.0.

Validation

Run the smallest applicable Windows PowerShell or PowerShell checks:

.\scripts\check-trailing-whitespace.ps1
.\scripts\test-update.ps1

For changes that affect build behavior or the launcher, run:

.\scripts\build.ps1 -Compile -NoVendor -Verbose

For distribution changes, use the CI-equivalent build and package commands on Windows with msbuild and 7z available:

.\scripts\build.ps1 -Compile -Terminal all -Verbose
.\scripts\pack.ps1 -Terminal all -Verbose

Also run git diff --check before committing. Test user-facing startup or configuration changes on a fresh Windows environment when possible.

Code review

Diff the changes against main origin/main branch or the specified base branch.

Prior to starting a review ensure there are no uncommitted changes.

  • If doing an interractive code ask the user about committing files.
  • Required uncommitted changes should be committed with relevant commit messages.
  • If there are unreleated changes in the same commit, split them into separate commits.

Create an untracked code_review_findigs.md file to document any issues found during the review. Include the following information for each issue:

  • Status: Open, Fixed, or Won't Fix
  • File name and line number
  • Description of the issue
  • Proposed solution or recommendation

Make sure there is an appropriately versioned CHANGELOG entry for any changes that affect the user experience, including new features, improvements, bug fixes, and breaking changes. If the change is a bug fix, include the issue number in the CHANGELOG entry.

Prioritize behavior regressions over style. Review changes with these repository-specific checks:

  • Startup and launcher changes must preserve existing cmd.exe, PowerShell, Git Bash, Mintty, ConEmu, and Windows Terminal behavior where applicable. Pay particular attention to upgrade compatibility for existing user task configurations and init.bat callers.
  • Verify that shipped scripts do not overwrite user-owned configuration or assume a fixed installation path, shell, terminal, or external Git installation.
  • For PowerShell changes, check Windows PowerShell 5.1 compatibility, $PSScriptRoot initialization timing, encoding, quoting, and error propagation; CI running PowerShell 7 is not sufficient coverage by itself.
  • For build and packaging changes, verify every affected terminal profile and full/no-Git package variant. Flag hardcoded vendor or package branches that should be expressed through package-profiles.json.
  • For vendor updates, confirm the version, URL, package inclusion, release notes, and generated artifacts stay consistent.
  • For launcher changes, verify both x64 and Win32 release configurations and review command-line parsing, path quoting, and settings backup/restore.
  • Treat changes to .gitattributes, scripts, and workflow files as release affecting. Confirm the matching CI checks and documentation are updated.

CodeReview Changes

When fixing issues found during code review, please make sure to address all the comments and suggestions provided by the reviewer.

If you disagree with any feedback, provide a clear explanation for your decision.

Commits should indicate it is a code review finding fix, be atomic and focused on a single change, avoid bundling unrelated changes together.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.