- Home
- Skills
- Technical Documentation
- CLI Reference Page: Command-Line Docs from Your Code
More screenshots
Works with the AI Agents you already use
CLI Reference Page: Command-Line Docs from Your Code
- `cli-reference.html`: the same as one printable page.
$5
CLI Reference Page: Command-Line Docs from Your Code
Example session with this skill installed
Write the reference page for our shelfwise CLI from its code, with examples, exit codes and clearer error messages.
- Read your context and instructions
- Compiled the cli reference page
shelfwise stock adjust
Source: shelfwise/cli.py:94
Change the count of one title by DELTA (negative to take away). A negative DELTA must come after --, or click
reads it as an option: shelfwise stock adjust --reason damaged -- 9780000000001 -2.
shelfwise stock adjust [OPTIONS] ISBN DELTA
| Argument | Required | Count | Default | Choices | Help | Source |
|---|---|---|---|---|---|---|
ISBN | yes | 1 | — | — | — (no help text in the code) | shelfwise/cli.py:95 |
DELTA | yes | 1 | — | — | From code: a whole number (type=int); 0 is refused (shelfwise/cli.py:102). | shelfwise/cli.py:96 |
| Flag | Value | Default | Required | Choices | Help | Source |
| --- | --- | --- | --- | --- | --- | --- |
--reason | REASON | — | yes | sale, damaged, lost, recount | Why the count changes. | shelfwise/cli.py:97 |
--note | TEXT | "" | no | — | — (no help text in the code) | shelfwise/cli.py:99 |
Error messages
shelfwise init: the settings file already exists
- Found: "{target} already exists" (
shelfwise/cli.py:40, click.UsageError, exit code 2 from click) - Suggestion: "shelfwise.toml already exists. Run shelfwise init --overwrite to replace it, or choose another file with --config."
ref_check.py:
summary: 0 FIX, 0 ADVICE in cli-reference.md (7 commands, 17 option rows, 9 examples matched, 4 open questions). It checks the page against what the scan recognized; options defined at run time may be missing, and examples were matched against the definitions, not run.
Connects securely to your tools. The creator never sees your data.
About this skill
English
For developers who ship a command-line tool and need its docs to match the code.
Point your agent at the repository. You get back the reference page for your CLI, built from its own code: every command and option with its default and choices, examples that use only real flags, exit codes and error messages found in the code, and a clearer wording suggested for each message, every fact with its file and line.
What you get each run
cli-reference.md: install and run, synopsis, global options, one section per command with argument and option tables, examples, environment variables, exit codes, error messages with suggestions, what was not resolved, and questions for the team.cli-reference.html: the same as one printable page.cli.json: what the scan found, every fact with its file and line.
Read from your code
A bundled Python script (standard library, read-only, no network calls) reads Python argparse, click and typer definitions with the ast module, and Node commander definitions with a tokenizer. It never imports or runs your code. It finds programs, commands, subcommands, options, arguments, choices, defaults, environment variables, exit codes and error messages. Other frameworks (yargs, cobra, clap and others) are listed as found, not read, and anything built at run time is listed as not resolved, never guessed.
Examples that use only what exists
Every example uses commands and flags the scan found, fills every required argument, and follows the parser's own rules. Current error messages are quoted exactly; a clearer wording appears only on a line marked as a suggestion.
Checked, not just written
A checker confirms that every documented command, flag, default and choice matches the scan, every cited line exists and holds the definition, every example uses only known flags with its required arguments, and every suggestion is labelled. The agent fixes and checks again until no FIX is left.
Honest about its limits
The page holds what the scan recognized and what the agent read by hand, and says that completeness is not verified: commands registered at run time or added by helpers may be missing. Examples are matched against the definitions, not run.
Arabic
The page can be written in Arabic with a right-to-left layout; commands, flags and the program's own messages stay exactly as in the code.
In the download: SKILL.md, the scripts, references (the page format, and how to read yargs, cobra, clap and other frameworks by hand), and two complete examples so you can see the output before you buy: a Python click tool with 7 commands in English, and a Node commander tool in Arabic.
بالعربي
للمبرمجين الذين لديهم أداة سطر أوامر ويحتاجون وثائقها مطابقة للكود.
وجّه وكيلك إلى المستودع. تستلم صفحة مرجع أوامر أداتك مبنية من الكود نفسه: كل أمر وخيار مع قيمته الافتراضية واختياراته، وأمثلة لا تستعمل إلا خيارات حقيقية، ورموز الخروج ورسائل الخطأ الموجودة في الكود، مع صياغة أوضح مقترحة لكل رسالة، وكل معلومة بملفها وسطرها.
ماذا تستلم في كل مرة
- ملف
cli-reference.md: التثبيت والتشغيل، والصيغة العامة، والخيارات العامة، وقسم لكل أمر بجداول المعاملات والخيارات، وأمثلة، ومتغيرات البيئة، ورموز الخروج، ورسائل الخطأ مع اقتراحاتها، وما لم يُحسم، وأسئلة للفريق. - صفحة
cli-reference.html: الشيء نفسه كصفحة واحدة قابلة للطباعة. - ملف
cli.json: ما وجده الفحص، وكل معلومة مع ملفها وسطرها.
من الكود نفسه
سكربت بايثون مرفق (يقرأ فقط، بلا اتصال بالشبكة) يقرأ تعريفات argparse وclick وtyper في بايثون بوحدة ast، وتعريفات commander في Node بمحلل نصوص. لا يستورد كودك ولا يشغّله. والأطر الأخرى تُذكر كموجودة لم تُقرأ، وما يُبنى وقت التشغيل يُذكر كغير محسوم، ولا يُخمَّن.
أمثلة لا تستعمل إلا ما هو موجود
كل مثال يستعمل أوامر وخيارات وجدها الفحص، ويملأ كل معامل مطلوب. ورسائل الخطأ الحالية منقولة حرفيًا، والصياغة الأوضح تظهر فقط في سطر مكتوب عليه أنه اقتراح.
مدقَّقة، لا مكتوبة فقط
أداة فحص تتأكد أن كل أمر وخيار وقيمة افتراضية واختيار يطابق الفحص، وكل سطر مذكور موجود وفيه التعريف، وكل مثال لا يستعمل إلا خيارات معروفة مع معاملاته المطلوبة. يصلح الوكيل ويعيد الفحص حتى لا يبقى أي FIX.
صادقة في حدودها
الصفحة تحمل ما تعرّف عليه الفحص وما قرأه الوكيل يدويًا، وتقول إن الاكتمال غير مؤكد: الأوامر التي تُسجَّل وقت التشغيل قد تفوت. والأمثلة مطابَقة مع التعريفات، لا مشغَّلة.
العربية
تُكتب الصفحة بالعربي من اليمين إلى اليسار، والأوامر والخيارات ورسائل البرنامج تبقى كما في الكود.
داخل الملف: ملف SKILL.md، والسكربتات، والمراجع، ومثالان كاملان لترى النتيجة قبل الشراء: أداة click في بايثون بسبعة أوامر بالإنجليزي، وأداة commander في Node بالعربي.
Reads Python argparse, click and typer (with the ast module) and Node commander in its common chained form; other frameworks (yargs, cobra, clap, oclif, picocli and others) are listed as found, not read, for the agent to read by hand. Anything built at run time (flags made in a loop, options added by helpers, plugins) is listed as not resolved, so completeness is not verified. Exit codes and error messages are those found in the code. Examples are matched against the definitions, not run. cli-reference.html loads its fonts from Google Fonts when online and falls back to system fonts offline. الصفحة تحمل ما تعرّف عليه الفحص، والاكتمال غير مؤكد.
How to use
- 1
Connect your agent to the Agensi MCP
Copy the prompt and paste it into Claude, ChatGPT, Cursor or any agent that supports MCP. It sets up the connection for you. Manual setup
- 2
Sign in to Agensi
Your agent shows a sign-in link. Sign in and click Allow.
- 3
Ask for what you need
Your agent loads this skill and uses it on your task. It always asks before any payment.
Reviews
No reviews yet
Be one of the first to try it. Every listed skill goes through the trust checks below.
Security scanned
Checked by our 8-point scan before listing
Fresh listing
Recently published to Agensi
Money-back guarantee
Doesn't do what its page promises? You get your money back.
Trust & safety
Security scan
Security scan passed 3 days ago
Requires
Permissions
Reads the repository's source files, writes cli.json, cli-reference.md and cli-reference.html in a cli folder, and runs its local Python scripts (cli_scan.py, ref_check.py, make_page.py). The scripts never import or run your code and make no network calls. يقرأ الكود ويكتب ملفات الصفحة فقط، ولا يشغّل برنامجك.