skills.rest
l0lxl0lw
l0lxl0lwCOMMUNITY
Explore all skills by this author →
GitHub

readme

Extract and execute shell commands documented in a project README file.

Updated Dec 18, 2025
Search Tags:#automation#documentation#project setup#bash#readme#shell#command extraction
One-click install
npx skills add https://github.com/l0lxl0lw/dotfiles --skill readme-l0lxl0lw
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme
Source: https://github.com/l0lxl0lw/dotfiles/tree/main/ai/shared/skills/utilities/readme
Command: npx skills add https://github.com/l0lxl0lw/dotfiles --skill readme-l0lxl0lw

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve? New projects often bury their setup, build, and test instructions inside README files, forcing you to manually read, interpret, and run each command. This Skill automates that process by extracting executable commands from the README and running them with your confirmation. ## Core Features & Use Cases - Command Extraction: A shell script parses fenced code blocks (bash, sh, shell, zsh) and inline backtick commands from README files. - Purpose Grouping: Commands are categorized as setup, build, test, run, lint, deploy, or cleanup for organized review. - Safe Execution: Commands run sequentially with stop-on-first-error behavior, and destructive commands require explicit confirmation. - Use Case: After cloning an unfamiliar repository, run this Skill to discover its npm install, build, and test commands, then execute the setup steps interactively. ## Quick Start Ask the assistant to read the README in the current directory and run the setup commands it describes.

Frequently Asked Questions about readme

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

FAQPage Schema
How do I run commands from a README file automatically?▼

Use the extraction script to parse fenced bash, sh, shell, or zsh code blocks and inline backtick commands from the README. Commands are grouped by purpose such as setup, build, and test, then executed sequentially after your confirmation.

How to extract shell commands from Markdown documentation?▼

The extract-commands.sh script uses awk to capture fenced code blocks tagged bash, sh, shell, zsh, or console, and grep to find inline backtick commands starting with common tools like npm, pip, cargo, docker, and make.

Does it execute destructive commands like rm -rf automatically?▼

No. Destructive commands such as rm -rf, drop, delete, or reset --hard always require explicit user confirmation before running. Execution also stops on the first error and reports which command failed.

What happens if no README file is found in the directory?▼

The script checks for README.md, README, readme.md, readme.txt, and README.txt in the target directory. If none exists, it exits with an error message stating no README file was found.

Can it handle commands that require environment variables or secrets?▼

Commands requiring missing environment variables are skipped and the user is informed. When credentials or secrets are needed, the Skill prompts the user rather than guessing values.

Related Skills

Explore More Software Engineering Skills→
langify-orglangify-org

ws-navigate

Read, diff, and copy files across worktrees in a ws-managed bare clone repository.

Official
Intermediate
giladresisigiladresisi
3

init-project

Initialize a Python project environment with dependencies, Dockerized PostgreSQL, migrations, and FastAPI server.

Community
Basic
karimatayutakarimatayuta

deps

Audit, update, and secure Python dependencies using uv and pyproject.toml.

Community
Intermediate
eveldeveld
10

discover-project-commands

Inventory project commands from Makefiles and npm scripts into a reference document.

Community
Intermediate