skills.rest
Jitsusama
JitsusamaCOMMUNITY
Explore all skills by this author →
GitHub

gh-cli-conventions

Format GitHub CLI commands with heredoc syntax and title conventions.

6|3|Updated Mar 8, 2026
Search Tags:#pull requests#issues#gh#github cli#command formatting#cli conventions
One-click install
npx skills add https://github.com/Jitsusama/agentic-harness.pi --skill gh-cli-conventions
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: gh-cli-conventions
Source: https://github.com/Jitsusama/agentic-harness.pi/tree/main/skills/gh-cli-conventions
Command: npx skills add https://github.com/Jitsusama/agentic-harness.pi --skill gh-cli-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures your GitHub CLI commands are correctly formatted, preventing errors and improving clarity when interacting with GitHub repositories.

Core Features & Use Cases

  • Heredoc Syntax: Properly use heredocs for multi-line command bodies, avoiding shell expansion issues.
  • Title Conventions: Adhere to best practices for PR and issue titles (Title Case, outcome-oriented).
  • Metadata Handling: Learn to add assignees and labels using separate commands for cleaner workflows.
  • Line Wrapping: Understand how GitHub's markdown renderer handles line breaks in descriptions, avoiding hard-wrapping.
  • Use Case: When creating a pull request via the command line, this skill helps you format the title and body correctly, and add labels and assignees efficiently.

Quick Start

Use the gh-cli-conventions skill to format a GitHub CLI command for creating a pull request with a specific title and body.

Frequently Asked Questions about gh-cli-conventions

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

FAQPage Schema
How do I format multi-line bodies when creating a pull request with the GitHub CLI?▼

To format multi-line bodies in the GitHub CLI, use heredoc syntax. This approach prevents shell expansion issues and ensures your pull request descriptions are passed correctly without formatting errors.

What is the best way to add labels and assignees to an issue using gh commands?▼

The best way to add labels and assignees to an issue is by using separate GitHub CLI commands after creation. This metadata handling approach maintains cleaner workflows and prevents complex command string formatting.

Why do my GitHub CLI PR descriptions render with unexpected line breaks?▼

GitHub CLI PR descriptions render with unexpected line breaks because GitHub's markdown renderer handles line wrapping automatically. You should avoid hard-wrapping text in your heredoc bodies to prevent these formatting issues.

What title conventions should I follow for GitHub CLI pull requests and issues?▼

Title conventions for GitHub CLI pull requests and issues recommend using Title Case and making them outcome-oriented. This ensures clarity and adheres to best practices for repository management.

Can I use shell expansion inside GitHub CLI heredoc syntax for command bodies?▼

You cannot safely use shell expansion inside GitHub CLI heredoc syntax for command bodies. Heredoc syntax is specifically recommended to avoid shell expansion issues when passing multi-line strings to the GitHub CLI.

Related Skills

Explore More Software Engineering Skills→
john-data-chenjohn-data-chen
2

github-auth

Authenticate to GitHub across git and gh CLI.

Community
Intermediate
piemontepiemonte
1

github

Manage GitHub pull requests, issues, releases, and gists via the gh CLI.

Community
Intermediate
pratikrath126pratikrath126
42

bash-linux

Provides Bash/Linux terminal patterns and scripting practices for command-line work.

Community
Intermediate
winsorllcwinsorllc

github-ops

Manage GitHub repositories, issues, pull requests, and workflows via the REST API.

Community
Advanced