Skip to content

Commit 8861932

Browse files
claudeclaude
committed
Add LLM tools documentation page
Covers machine-readable documentation (llms.txt, llms-full.txt) and the psake Agent Skill for AI-assisted development. https://claude.ai/code/session_01XVwxRFNLkH7Ee91dk5Vyuy
1 parent f1293a8 commit 8861932

File tree

2 files changed

+135
-0
lines changed

2 files changed

+135
-0
lines changed

‎docs/reference/llm-tools.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title: "LLM Tools"
3+
description: "Machine-readable documentation and AI assistant integrations for psake, including llms.txt files and the psake Agent Skill"
4+
---
5+
6+
# LLM Tools
7+
8+
psake provides several tools to help Large Language Models (LLMs) and AI coding assistants understand and work with your build automation. These tools make it easier to get AI-assisted help when writing psakefiles, troubleshooting builds, or learning psake concepts.
9+
10+
## Machine-Readable Documentation
11+
12+
### llms.txt
13+
14+
The psake documentation site provides machine-readable text files optimized for LLMs:
15+
16+
| File | Description | URL |
17+
|------|-------------|-----|
18+
| `llms.txt` | Condensed site overview with key pages | [psake.dev/llms.txt](https://psake.dev/llms.txt) |
19+
| `llms-full.txt` | Complete site content as markdown | [psake.dev/llms-full.txt](https://psake.dev/llms-full.txt) |
20+
21+
These files follow the [llms.txt standard](https://llmstxt.org/) for providing website content in a format that LLMs can easily consume.
22+
23+
### When to Use Each File
24+
25+
**Use `llms.txt` when:**
26+
- You need a quick overview of psake
27+
- Your LLM has limited context window
28+
- You want to provide general psake knowledge
29+
30+
**Use `llms-full.txt` when:**
31+
- You need comprehensive documentation
32+
- You're troubleshooting complex issues
33+
- You want the AI to have access to all examples and reference material
34+
35+
### Example Usage
36+
37+
You can paste the contents of these files directly into your AI conversation, or reference the URLs when using tools that support web fetching:
38+
39+
```
40+
Please read https://psake.dev/llms-full.txt and help me create a psakefile
41+
for a .NET solution with multiple projects.
42+
```
43+
44+
## psake Agent Skill
45+
46+
The [psake Agent Skill](https://github.com/psake/psake-llm-tools) is a specialized knowledge package that enables AI coding assistants like Claude and GitHub Copilot to provide expert assistance with psake build automation tasks.
47+
48+
### What is an Agent Skill?
49+
50+
Agent Skills are portable knowledge packages built on the open [Agent Skills](https://agentskills.io/) standard. They provide structured expertise that AI assistants can use to give more accurate, context-aware guidance for specific tools and technologies.
51+
52+
### What's Included
53+
54+
The psake Agent Skill includes four comprehensive knowledge components:
55+
56+
| Component | Description |
57+
|-----------|-------------|
58+
| **SKILL.md** | Core psake fundamentals—command syntax, task definitions, dependencies, and troubleshooting patterns |
59+
| **PowerShell Modules Reference** | Guidance on using PowerShellBuild for module development workflows |
60+
| **Build Types Reference** | Practical patterns for .NET, Node.js, and Docker builds |
61+
| **Advanced Reference** | Dynamic task generation, custom logging, and CI/CD integration |
62+
63+
### What AI Assistants Can Help With
64+
65+
Once you've loaded the psake skill, your AI assistant can help with:
66+
67+
- Building complete psakefiles with integrated Pester testing frameworks
68+
- Establishing build configurations for .NET solutions and PowerShell modules
69+
- Implementing dynamic task generation from configuration files
70+
- Troubleshooting build failures and dependency issues
71+
- Integrating psake workflows into CI/CD pipelines
72+
- Creating custom logging mechanisms
73+
- Developing cross-platform build scripts
74+
75+
### Installation
76+
77+
#### Using with Claude
78+
79+
1. Visit the [psake-llm-tools repository](https://github.com/psake/psake-llm-tools)
80+
2. Download the `psake.skill` file from the releases section
81+
3. Upload it to Claude through the skills interface
82+
4. Start building with AI-assisted psake expertise
83+
84+
#### Using with GitHub Copilot
85+
86+
1. Download the `psake.skill` file from the [repository](https://github.com/psake/psake-llm-tools)
87+
2. Follow the [VS Code instructions for using shared skills](https://code.visualstudio.com/docs/copilot/customization/agent-skills#_use-shared-skills)
88+
3. Configure the skill in your workspace or user settings
89+
4. Access psake expertise directly in your editor
90+
91+
The same skill file works across both platforms, making it easy to maintain consistent AI assistance regardless of which tool you prefer.
92+
93+
## Best Practices
94+
95+
### Getting Better AI Assistance
96+
97+
When asking AI assistants for help with psake:
98+
99+
1. **Provide context** - Share your current psakefile or describe your project structure
100+
2. **Be specific** - Mention the specific task, error, or pattern you need help with
101+
3. **Share error messages** - Include full error output when troubleshooting
102+
4. **Mention your environment** - PowerShell version, OS, and any relevant modules
103+
104+
### Example Prompts
105+
106+
Here are some effective ways to ask for psake help:
107+
108+
```
109+
I'm using psake to build a .NET 8 solution. Help me create a task that
110+
runs tests with code coverage and fails if coverage is below 80%.
111+
```
112+
113+
```
114+
My psake build is failing with "Task 'Deploy' has not been defined."
115+
Here's my psakefile: [paste code]. What's wrong?
116+
```
117+
118+
```
119+
How do I pass parameters from my CI/CD pipeline to my psakefile?
120+
I'm using GitHub Actions.
121+
```
122+
123+
## Contributing
124+
125+
The psake-llm-tools repository is open source and welcomes community contributions. If you have patterns, examples, or improvements that would benefit other developers using psake with AI assistants, we'd love to see your pull requests.
126+
127+
Visit [github.com/psake/psake-llm-tools](https://github.com/psake/psake-llm-tools) to contribute.
128+
129+
## See Also
130+
131+
- [Quick Start](/docs/intro) - Get started with psake
132+
- [Cheat Sheet](/docs/reference/cheat-sheet) - Quick reference for common patterns
133+
- [Command Reference](/docs/commands/Invoke-psake) - Detailed command documentation
134+
- [Troubleshooting](/docs/troubleshooting/common-errors) - Common errors and solutions

‎sidebars.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ const sidebars: SidebarsConfig = {
8686
'reference/cheat-sheet',
8787
'reference/glossary',
8888
'reference/exit-codes',
89+
'reference/llm-tools',
8990
]
9091
},
9192
{

0 commit comments

Comments
 (0)