Powershell-Copilot-Standards readme.instructions.md

Instructions for creating detailed README files for PowerShell projects. A README is a project guide covering its purpose, users, requirements, installation, and use.

In plain words
What is it for?
Use it when starting or updating a PowerShell project's README, including its supported PowerShell versions, platforms, dependencies, installation methods, and current status.
Why use it?
It helps turn project details into consistent documentation that developers, administrators, and users can understand.

Instructions file for GitHub Copilot

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/fadwen/powershell-copilot-standards/readme
Clone the repo
git clone --depth 1 https://github.com/fadwen/Powershell-Copilot-Standards

Made for: GitHub Copilot.

Per session 3,652 This file is loaded in full into every session.
When invoked 3,652 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.03652 $0.03652
Opus 5 $0.01826 $0.01826
Sonnet 5 $0.00730 $0.00730
Haiku 4.5 $0.00365 $0.00365

Measured 2d ago against content hash 8700c2c13dce, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Powershell-Copilot-Standards readme.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/readme.instructions.md · 535 lines

How it starts

The opening of the file, as written. The whole thing — 535 lines — stays where its author put it; the contents beside it link to each section on GitHub.

PowerShell README Documentation Generator

Create comprehensive, enterprise-grade README documentation that serves as both technical reference and business communication tool. Generate documentation that supports automatic integration, provides clear value proposition, and maintains consistency with organizational standards.

README Generation Requirements

Content Assessment

Gather information needed for complete README generation:

Project Information
  • Project Name: Clear, descriptive name following PowerShell conventions
  • Primary Purpose: Business value and technical function
  • Target Audience: System administrators, developers, end users, or automation systems
  • Key Features: Core capabilities and unique value propositions
  • Dependencies: Required modules, system requirements, and external services
  • Current Status: Development phase, version, and maturity level
Technical Specifications
  • PowerShell Versions: State the supported range explicitly — PowerShell 7.6 (LTS) is the current target; note Windows PowerShell 5.1 support only if actually tested
  • Platform Support: Windows, Linux, macOS, or cross-platform
  • Installation Methods: PowerShell Gallery, manual installation, or enterprise deployment
  • Configuration Requirements: Environment setup, credentials, and permissions
  • Integration Points: External systems, APIs, databases, or services

Comprehensive README Structure

Generate Complete README with Required Sections

Header Section with Badges
# Project Title

[![Build Status](https://img.shields.io/badge/build-passing-brightgreen)](./Actions)
[![PowerShell Gallery](https://img.shields.io/badge/PowerShell%20Gallery-v1.0.0-blue)](https://www.powershellgallery.com/)
[![License](https://img.shields.io/badge/license-MIT-green)](./LICENSE)
[![Coverage](https://img.shields.io/badge/coverage-85%25-brightgreen)](./Tests/Results/)
📖 Overview Section

Create compelling overview with business focus:

Read the full file on GitHub · 535 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 535 lines · 3,652 tokens per session scan A 8700c2c13dce

Subscribe to this mod's changes

Powershell-Copilot-Standards readme.instructions.md is an instructions file published in the GitHub repository fadwen/Powershell-Copilot-Standards (19 stars, last pushed 2d ago), licensed MIT. It adds 3,652 tokens to every session, about $0.0183 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.