igorwarzocha__opencode-workflows/commands/.opencode/command/howto.md at master

mirror of https://github.com/IgorWarzocha/Opencode-Workflows.git synced 2026-09-14 16:22:53 +08:00

Files

T

OpenCode Agent 2698a1d765 feat: comprehensive repository overhaul and standardization

- Implement internal maintenance suite: repo-maintainer agent and automated audit/sync scripts.
- Add "Opencode Configurator" suite: agent-architect, command-creator, and skill-creator.
- Refactor core commands (/improve, /refactor, /rmslop) to RFC 2119 + XML standards.
- Standardize all agent metadata and structural tagging across the repository.
- Introduce utility commands: /npm for package management and /create-pack for bundling.
- Overhaul README.md and documentation to reflect new workflow patterns.

2026-01-12 18:16:06 +00:00

4.0 KiB

Raw Permalink Blame History

description

description
Generate exhaustive repository guide for user assistance

Analyze this repository and create an AGENTS.md file for assisting users with setup, running, and troubleshooting.

This is NOT for development assistance - it's for END-USER assistance only.

Gather Repository Context
- Read root package.json to identify project name and type
- Read root README.md for basic project info
- List root directory contents to understand structure
Search Official Documentation
- Use web search to find official documentation resources
- Query: "[repository name] documentation" and "[repository name] getting started"
- Look for official docs sites, README links, llms.txt files
- Find getting started guides and API references
- MUST gather real URLs from web search
Analyze Repository Structure
- List IMPORTANT directories only (ignore node_modules, .git, etc.)
- Identify key config files, documentation, scripts
- Focus on directories/files users interact with for setup/usage
- Maximum 2-3 levels deep for directory exploration
Explore Installation Methods
- Check for install scripts (install, setup, etc.)
- Look for package manager installation docs
- Find prerequisites and environment setup instructions
- Identify configuration files and environment variables
Identify Running/Usage Patterns
- Find CLI commands and entry points
- Look for start/launch scripts
- Check for GUI/desktop app information
- Identify common usage patterns from documentation
Document Troubleshooting Resources
- Find log file locations
- Identify debug methods and flags
- Look for common issues in docs
- Check for configuration validation methods
Create AGENTS.md
- Write comprehensive user assistance guide
- Use the structure specified below
- MUST be actionable and concise (LLM reference, not user docs)
- Focus on practical information for helping users

<output_structure>

Repository Overview

Software type and purpose (1 line)
Main technologies used (tech stack)
Installation methods available

Official Documentation Resources

Primary documentation URLs (from web search)
Getting started guides
CLI/reference documentation
Troubleshooting guides
Community resources (Discord, issues, etc.)

Key Directory Structure

List only IMPORTANT directories with brief descriptions:

dir/ - purpose (e.g., "Main source code", "Configuration files")
file - purpose (e.g., "Main entry point", "Installation script")

Focus on what users interact with for setup/usage.

Setup & Installation

Prerequisites (what users need before installing)
Installation commands (all available methods)
Configuration steps (initial setup)
Environment variables (important ones)

Running & Usage

Start/launch commands
Common usage patterns
CLI commands and flags
GUI access methods (if applicable)

Troubleshooting

Common issues and solutions
Log locations
Debug methods and flags
Configuration validation

Key Files for Reference

List files containing important information:

README locations
Config file examples
Documentation files
Script files

</output_structure>

MUST use web search to find actual documentation URLs
MUST keep content concise and actionable
MUST focus on END-USER assistance, not development
SHOULD verify claims with tools before stating them
SHOULD use parallel tool calls when gathering information
MUST NOT include internal development workflows
MUST NOT include contributor/development instructions

<quality_checklist>

Web search performed for official docs
All documentation URLs are real and verified
Directory structure focuses on user-facing files
Installation commands are accurate
Troubleshooting section includes log locations
Content is concise (LLM reference, not user docs)
No development/contributing instructions included </quality_checklist>

4.0 KiB Raw Permalink Blame History