x-cmd-advise

Name: x-cmd-advise
Availability: InStock
Author: x-cmd

Guide creation of x-cmd advise specs with YAML structure and field semantics.

4.6k|161|Updated Oct 1, 2022

Search Tags:#shell scripting #yaml #shell #completion help #advise spec

Ready to run

npx skills add https://github.com/x-cmd/x-cmd --skill x-cmd-advise

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: x-cmd-advise
Source: https://github.com/x-cmd/x-cmd/tree/main/mod/advise/lib/spec
Command: npx skills add https://github.com/x-cmd/x-cmd --skill x-cmd-advise

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires x-cmd, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides an authoritative guide to creating well-structured and efficient x-cmd advise (completion/help specs), which simplifies the process of authoring helpful documentation for shell scripts.

Core Features & Use Cases

YAML Structure Guide: Offers a comprehensive guide to the correct YAML structure for advise specs.
Field Semantics: Explains the semantics of various fields used in advise specs.
Writing Tips: Provides practical tips for writing concise and clear advise.
Error Patterns: Identifies common errors and how to avoid them.
Lint Workflow: Describes the process of linting advise specs to ensure they are structurally sound.

Quick Start

Use the x-cmd-advise skill to review the specifications for the 'adv/index.yml' file.

Frequently Asked Questions about x-cmd-advise

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I write an x-cmd advise spec for shell command completion?▼

To write an x-cmd advise spec, you define a YAML structure that provides completion help for shell commands. This skill guides you through the correct field semantics and writing conventions for the 'adv/index.yml' file.

What is the correct YAML structure for x-cmd advise files?▼

The correct YAML structure for x-cmd advise files involves specific fields that define completion help for shell commands. This skill provides a comprehensive guide to these structural requirements and field semantics to ensure your specs are sound.

How do I avoid common errors when authoring shell completion help specs?▼

To avoid common errors when authoring shell completion help specs, you should follow the identified error patterns and writing tips provided. This skill explains how to write concise advise and avoid structural mistakes in your YAML files.

How do I lint x-cmd advise specs to ensure they are structurally sound?▼

You can lint x-cmd advise specs by following the described lint workflow to ensure they are structurally sound. This process validates the YAML structure and field semantics of your shell command completion help files.

Do I need x-cmd installed to create completion help specs for shell scripts?▼

Yes, you need the x-cmd dependency installed to create completion help specs for shell scripts. This skill is specifically designed for x-cmd module developers and shell script authors authoring advise files within that environment.