skills.rest
hdeshev
hdeshevCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

describe

Look up Emacs documentation for functions, variables, faces, and key bindings via emacsclient.

Updated May 2, 2026
Search Tags:#documentation#emacs#elisp#lookup#describe#emacsclient#key bindings
One-click install
npx skills add https://github.com/hdeshev/pi-config --skill describe-hdeshev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: describe
Source: https://github.com/hdeshev/pi-config/tree/main/agent/skills/emacs-describe
Command: npx skills add https://github.com/hdeshev/pi-config --skill describe-hdeshev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? When working in Emacs, you often need quick answers about what a function does, what a variable controls, or which key a command is bound to. This Skill queries a running Emacs instance directly and returns consolidated documentation without leaving your conversation. ## Core Features & Use Cases - Multi-mechanism lookup: Searches functions, variables, faces, key bindings, and apropos results in a single emacsclient call. - Live Emacs integration: Uses emacsclient --eval to query your actual running Emacs session, so results reflect your real configuration. - Summarized answers: Returned documentation is summarized in the conversation for quick reading. - Use Case: You want to know what dired-mark does and which keys invoke it. Invoke /describe with the query and receive a summary of its function documentation, related bindings, and apropos matches. ## Quick Start Ask the assistant to look up Emacs documentation for a symbol like "dired-mark" using the describe skill.

Frequently Asked Questions about describe

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

FAQPage Schema
How do I look up Emacs function documentation from the command line?▼

Use emacsclient --eval to call describe-function or a helper like agent-skill-describe inside your running Emacs session. This returns the documentation string for the queried symbol directly to the caller.

How to search Emacs docs for functions, variables, and key bindings at once?▼

The agent-skill-describe helper queries multiple mechanisms in one call: function docs, variable docs, faces, key bindings, and apropos. It returns all findings as a single combined string.

Does emacsclient require a running Emacs server?▼

Yes, emacsclient connects to an Emacs instance running in server mode. Start the server with M-x server-start or by launching Emacs as a daemon before issuing eval commands.

Why does emacsclient --eval fail to find my symbol?▼

The symbol may not be loaded in the current Emacs session, or the query may be misspelled. Apropos search helps locate similarly named symbols when an exact match fails.

Can I query Emacs documentation without a running Emacs instance?▼

No, this approach depends on a live Emacs process because documentation lives in loaded Lisp libraries. Without a server, you would need to read the Emacs manual or source files directly.

Related Skills

Explore More Software Engineering Skills→
Jamie-CuiJamie-Cui

emacs

Reproduce Emacs package load failures in a live session via emacsclient.

Community
Intermediate
captainflasmrcaptainflasmr
100

emacs-lisp-helper

Write, understand, and debug Emacs Lisp code with formatted docstrings.

Community
Intermediate
plurigridplurigrid
60

emacs-info

Navigate and query Emacs Info manuals for Emacs, Elisp, and GNU tools.

Official
Intermediate
JylhisJylhis
1

emacs-introspection

Query Emacs help, Info manuals, and source via batch evaluation.

Community
Advanced